MCPcopy Create free account
hub / github.com/TorqueGameEngines/Torque3D / dumpDoc

Function dumpDoc

Engine/source/console/engineDoc.cpp:46–89  ·  view source on GitHub ↗

Source from the content-addressed store, hash-verified

44
45
46static void dumpDoc( Stream& stream, const char* text, bool checkUngrouped = true )
47{
48 // Extract brief.
49
50 String brief;
51
52 if( text )
53 {
54 const char* briefTag = dStrstr( text, "@brief" );
55 if( !briefTag )
56 {
57 const char* newline = dStrchr( text, '\n' );
58 if( newline )
59 {
60 brief = String( text, newline - text );
61 text = newline + 1;
62 }
63 else
64 {
65 brief = text;
66 text = NULL;
67 }
68 }
69 }
70
71 // Write doc comment.
72
73 if( !brief.isEmpty() )
74 {
75 stream.writeText( "@brief " );
76 stream.writeText( brief );
77 stream.writeText( "\r\n\r\n" );
78 }
79
80 if( text )
81 stream.writeText( text );
82#ifdef USE_UNDOCUMENTED_GROUP
83 if( checkUngrouped && ( !text || !dStrstr( text, "@ingroup" ) ) )
84 {
85 smDocGroups.insertUnique( "UNDOCUMENTED", 0 );
86 stream.writeText( "\r\n@ingroup UNDOCUMENTED\r\n" );
87 }
88#endif
89}
90
91static void dumpFragment( Stream& stream, ConsoleDocFragment* fragment )
92{

Callers 2

dumpVariableFunction · 0.85
dumpEnumFunction · 0.85

Calls 6

dStrstrFunction · 0.85
insertUniqueMethod · 0.80
StringClass · 0.70
dStrchrFunction · 0.50
isEmptyMethod · 0.45
writeTextMethod · 0.45

Tested by

no test coverage detected