Click here to Skip to main content
15,891,828 members
Articles / Desktop Programming / MFC

Documenting Header Files

Rate me:
Please Sign up or sign in to vote.
2.95/5 (14 votes)
16 Sep 2003CPOL6 min read 63.8K   846   24  
This tool will turn a header file into an XML and/or HTML file for documentation purposes. The output may be merged with previously created or edited XML files.
// Helperfile for creating a CStringArray

#if !defined (_TEXTSTRINGSXML_INCLUDED_)
#define _TEXTSTRINGSXML_INCLUDED_

// string constants for XML files
// XML: start
extern const CString strXML_Head1;
extern const CString strXML_Head2;
extern const CString strXML_Head3;
//extern const CString strXML_Head4;
//extern const CString strXML_Head5;
//extern const CString strXML_Head6;
//extern const CString strXML_Head7;
//extern const CString strXML_Head8;
//extern const CString strXML_LinkCSS;

// XML Elements
extern const CString strXML_BoldStart;
extern const CString strXML_BoldEnd;
extern const CString strXML_UnderlineStart;
extern const CString strXML_UnderlineEnd;
extern const CString strXML_ItalicStart;
extern const CString strXML_ItalicEnd;
extern const CString strXML_TextBreak;
extern const CString strXML_DivisionStart;
extern const CString strXML_DivisionEnd;

extern const CString strXML_TextStart;
extern const CString strXML_TextEnd;

extern const CString strXML_TitleStart;
extern const CString strXML_TitleEnd;

extern const CString strXML_HeaderStart;
extern const CString strXML_HeaderEnd;
extern const CString strXML_DescriptionStart;
extern const CString strXML_DescriptionEnd;
extern const CString strXML_NameStart;
extern const CString strXML_NameEnd;
extern const CString strXML_BaseclassStart;
extern const CString strXML_BaseclassEnd;

extern const CString strXML_DocumentorStart;
extern const CString strXML_DocumentorEnd;
extern const CString strXML_Module_TitleStart;
extern const CString strXML_Module_TitleEnd;
extern const CString strXML_Module_DescriptionStart;
extern const CString strXML_Module_DescriptionEnd;

extern const CString strXML_Module_FunctionListStart;
extern const CString strXML_Module_FunctionListEnd;
extern const CString strXML_FunctionsShortStart;
extern const CString strXML_FunctionsShortEnd;
extern const CString strXML_FunctionShortStart;
extern const CString strXML_FunctionShortEnd;
extern const CString strXML_Module_FunctionsStart;
extern const CString strXML_Module_FunctionsEnd;
extern const CString strXML_ModuleFunctionStart;
extern const CString strXML_ModuleFunctionEnd;

extern const CString strXML_Module_VariableListStart;
extern const CString strXML_Module_VariableListEnd;
extern const CString strXML_VariablesStart;
extern const CString strXML_VariablesEnd;
extern const CString strXML_VariableStart;
extern const CString strXML_VariableEnd;

extern const CString strXML_StatisticsStart;
extern const CString strXML_StatisticsEnd;
extern const CString strXML_Line1Start;
extern const CString strXML_Line1End;
extern const CString strXML_Line2Start;
extern const CString strXML_Line2End;

extern const CString strXML_HIncludesListStart;
extern const CString strXML_HIncludesListEnd;
extern const CString strXML_HIncludesStart;
extern const CString strXML_HIncludesEnd;
extern const CString strXML_HIncludeStart;
extern const CString strXML_HIncludeEnd;

extern const CString strXML_CPPIncludesListStart;
extern const CString strXML_CPPIncludesListEnd;
extern const CString strXML_CPPIncludesStart;
extern const CString strXML_CPPIncludesEnd;
extern const CString strXML_CPPIncludeStart;
extern const CString strXML_CPPIncludeEnd;

extern const CString strXML_Module_ClassesStart;
extern const CString strXML_Module_ClassesEnd;

extern const CString strXML_ClassListStart;
extern const CString strXML_ClassListEnd;
extern const CString strXML_ClassDefinitionsStart;
extern const CString strXML_ClassDefinitionsEnd;
extern const CString strXML_ClassDefinitionStart;
extern const CString strXML_ClassDefinitionEnd;

extern const CString strXML_ClassStart;
extern const CString strXML_ClassEnd;

extern const CString strXML_MemberListStart;
extern const CString strXML_MemberListEnd;
extern const CString strXML_MembersStart;
extern const CString strXML_MembersEnd;
extern const CString strXML_MemberStart;
extern const CString strXML_MemberEnd;

extern const CString strXML_MethodsListStart;
extern const CString strXML_MethodsListEnd;
extern const CString strXML_MethodsShortStart;
extern const CString strXML_MethodsShortEnd;
extern const CString strXML_MethodShortStart;
extern const CString strXML_MethodShortEnd;
extern const CString strXML_MethodsStart;
extern const CString strXML_MethodsEnd;
extern const CString strXML_MethodStart;
extern const CString strXML_MethodEnd;

extern const CString strXML_ReturnValuesStart;
extern const CString strXML_ReturnValuesEnd;
extern const CString strXML_ReturnValueStart;
extern const CString strXML_ReturnValueEnd;

extern const CString strXML_ParametersStart;
extern const CString strXML_ParametersEnd;
extern const CString strXML_ParameterStart;
extern const CString strXML_ParameterEnd;

#endif //_TEXTSTRINGSXML_INCLUDED_

By viewing downloads associated with this article you agree to the Terms of Service and the article's licence.

If a file you wish to view isn't highlighted, and is a text file (not binary), please let us know and we'll add colourisation support for it.

License

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)


Written By
Software Developer (Senior)
Germany Germany
This member has not yet provided a Biography. Assume it's interesting and varied, and probably something to do with programming.

Comments and Discussions