Click here to Skip to main content
15,885,985 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.7K   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.
<?xml version="1.0" encoding="ISO-8859-1" ?>
<!DOCTYPE HDocumentor SYSTEM ".\HDocumentor.dtd" >
<!-- This file was generated by Headerfile Documentor -->
<HDocumentor anchor="ModulDocHeaderDocumentor" NAME="ModulDocHeaderDocumentor" class="Technik">
<Module.Title>DocHeaderDocumentor</Module.Title>
<Module.Description>
<Text>
Here should be a description of the module
</Text>
<Statistics>
<Line1>The module DocHeaderDocumentor contains no global variables.</Line1>
</Statistics>
<Statistics>
<Line1>The module DocHeaderDocumentor contains no global functions.</Line1>
</Statistics>
<Statistics>
<Line1>The module DocHeaderDocumentor contains one class definition.</Line1>
</Statistics>
<HIncludesList>
<Header>Included files by DocHeaderDocumentor.h:</Header>
<HIncludes>
<HInclude>&quot;ModulHelpers.h&quot;</HInclude>
<HInclude>&quot;Markup.h&quot;</HInclude>
</HIncludes>
</HIncludesList>
<CPPIncludesList>
<Header>Included files by DocHeaderDocumentor.cpp:</Header>
<CPPIncludes>
<CPPInclude> - unknown -</CPPInclude>
</CPPIncludes>
</CPPIncludesList>
<ClassList>
<Header>Class definitions:</Header>
<ClassDefinitions>
<ClassDefinition>CDocHeaderDocumentor</ClassDefinition>
<Baseclass>public CDocument</Baseclass>
</ClassDefinitions>
</ClassList>
</Module.Description>
<Class anchor="ClassCDocHeaderDocumentor" NAME="ClassCDocHeaderDocumentor">
<Header>CDocHeaderDocumentor</Header>
<Baseclass>
Base class: public CDocument
</Baseclass>
<Description>
Here should be a description of the class.
</Description>
<Statistics>
<Line1>The class CDocHeaderDocumentor contains 15 variables.</Line1>
<Line2>15 variables are private.</Line2>
</Statistics>
<Statistics>
<Line1>The class CDocHeaderDocumentor contains 38 functions.</Line1>
<Line2>One function is private.</Line2>
<Line2>8 functions are protected.</Line2>
<Line2>29 functions are public.</Line2>
</Statistics>
<MemberList anchor="ClassCDocHeaderDocumentorCV" NAME="ClassCDocHeaderDocumentorCV">
<Header>Data members of the class CDocHeaderDocumentor</Header>
<Description>
</Description>
<Members>
<Member Scope="private" Binding="dynamic" Target="#CVCDocHeaderDocumentorstatic_CStringArray_m_astrMacroessecol">
<Name>static CStringArray m_astrMacroes;</Name>
<Description>
Here should be a short description of the variable.
</Description>
</Member>
<Member Scope="private" Binding="dynamic" Target="#CVCDocHeaderDocumentorstatic_CStringArray_m_astrNotReturnssecol">
<Name>static CStringArray m_astrNotReturns;</Name>
<Description>
Here should be a short description of the variable.
</Description>
</Member>
<Member Scope="private" Binding="dynamic" Target="#CVCDocHeaderDocumentorCStringArray_m_astrOutputsecol">
<Name>CStringArray m_astrOutput;</Name>
<Description>
Here should be a short description of the variable.
</Description>
</Member>
<Member Scope="private" Binding="dynamic" Target="#CVCDocHeaderDocumentorSModul_m_smModulsecol">
<Name>SModul m_smModul;</Name>
<Description>
Here should be a short description of the variable.
</Description>
</Member>
<Member Scope="private" Binding="dynamic" Target="#CVCDocHeaderDocumentorbool_m_bHeaderReadsecol">
<Name>bool m_bHeaderRead;</Name>
<Description>
Here should be a short description of the variable.
</Description>
</Member>
<Member Scope="private" Binding="dynamic" Target="#CVCDocHeaderDocumentorCString_m_strHeaderFilenamesecol">
<Name>CString m_strHeaderFilename;</Name>
<Description>
Here should be a short description of the variable.
</Description>
</Member>
<Member Scope="private" Binding="dynamic" Target="#CVCDocHeaderDocumentorCString_m_strHTMLFilenamesecol">
<Name>CString m_strHTMLFilename;</Name>
<Description>
Here should be a short description of the variable.
</Description>
</Member>
<Member Scope="private" Binding="dynamic" Target="#CVCDocHeaderDocumentorCString_m_strSaveXMLFilenamesecol">
<Name>CString m_strSaveXMLFilename;</Name>
<Description>
Here should be a short description of the variable.
</Description>
</Member>
<Member Scope="private" Binding="dynamic" Target="#CVCDocHeaderDocumentorCString_m_strReadXMLFilenamesecol">
<Name>CString m_strReadXMLFilename;</Name>
<Description>
Here should be a short description of the variable.
</Description>
</Member>
<Member Scope="private" Binding="dynamic" Target="#CVCDocHeaderDocumentorCString_m_strSavePathHTMLsecol">
<Name>CString m_strSavePathHTML;</Name>
<Description>
Here should be a short description of the variable.
</Description>
</Member>
<Member Scope="private" Binding="dynamic" Target="#CVCDocHeaderDocumentorCString_m_strSavePathXMLsecol">
<Name>CString m_strSavePathXML;</Name>
<Description>
Here should be a short description of the variable.
</Description>
</Member>
<Member Scope="private" Binding="dynamic" Target="#CVCDocHeaderDocumentorCString_m_strReadPathHsecol">
<Name>CString m_strReadPathH;</Name>
<Description>
Here should be a short description of the variable.
</Description>
</Member>
<Member Scope="private" Binding="dynamic" Target="#CVCDocHeaderDocumentorCString_m_strReadPathXMLsecol">
<Name>CString m_strReadPathXML;</Name>
<Description>
Here should be a short description of the variable.
</Description>
</Member>
<Member Scope="private" Binding="dynamic" Target="#CVCDocHeaderDocumentorCString_m_strXMLStringsecol">
<Name>CString m_strXMLString;</Name>
<Description>
Here should be a short description of the variable.
</Description>
</Member>
<Member Scope="private" Binding="dynamic" Target="#CVCDocHeaderDocumentorCMarkup_m_xmlMarkupsecol">
<Name>CMarkup m_xmlMarkup;</Name>
<Description>
Here should be a short description of the variable.
</Description>
</Member>
</Members>
</MemberList>
<MethodsList anchor="ClassCDocHeaderDocumentorCF" NAME="ClassCDocHeaderDocumentorCF">
<Header>Methods of the class CDocHeaderDocumentor</Header>
<Description>
</Description>
<MethodsShort>
<MethodShort Scope="public" Binding="dynamic" Target="#CFCDocHeaderDocumentorReadIniFile">
<Name>ReadIniFile</Name>
<Description>
Here should be a short description of the function.
</Description>
</MethodShort>
<MethodShort Scope="protected" Binding="dynamic" Target="#CFCDocHeaderDocumentorCDocHeaderDocumentor">
<Name>CDocHeaderDocumentor</Name>
<Description>
Here should be a short description of the function.
</Description>
</MethodShort>
<MethodShort Scope="public" Binding="dynamic" Target="#CFCDocHeaderDocumentorGetTextArray">
<Name>GetTextArray</Name>
<Description>
Here should be a short description of the function.
</Description>
</MethodShort>
<MethodShort Scope="public" Binding="dynamic" Target="#CFCDocHeaderDocumentorIsHeaderRead">
<Name>IsHeaderRead</Name>
<Description>
Here should be a short description of the function.
</Description>
</MethodShort>
<MethodShort Scope="public" Binding="dynamic" Target="#CFCDocHeaderDocumentorCreateKeywords">
<Name>CreateKeywords</Name>
<Description>
Here should be a short description of the function.
</Description>
</MethodShort>
<MethodShort Scope="public" Binding="dynamic" Target="#CFCDocHeaderDocumentorCreateSplitfiles">
<Name>CreateSplitfiles</Name>
<Description>
Here should be a short description of the function.
</Description>
</MethodShort>
<MethodShort Scope="public" Binding="dynamic" Target="#CFCDocHeaderDocumentorUseStyleSheet">
<Name>UseStyleSheet</Name>
<Description>
Here should be a short description of the function.
</Description>
</MethodShort>
<MethodShort Scope="public" Binding="dynamic" Target="#CFCDocHeaderDocumentorDocumentPublic">
<Name>DocumentPublic</Name>
<Description>
Here should be a short description of the function.
</Description>
</MethodShort>
<MethodShort Scope="public" Binding="dynamic" Target="#CFCDocHeaderDocumentorDocumentProtected">
<Name>DocumentProtected</Name>
<Description>
Here should be a short description of the function.
</Description>
</MethodShort>
<MethodShort Scope="public" Binding="dynamic" Target="#CFCDocHeaderDocumentorDocumentPrivate">
<Name>DocumentPrivate</Name>
<Description>
Here should be a short description of the function.
</Description>
</MethodShort>
<MethodShort Scope="public" Binding="dynamic" Target="#CFCDocHeaderDocumentorDocumentExternal">
<Name>DocumentExternal</Name>
<Description>
Here should be a short description of the function.
</Description>
</MethodShort>
<MethodShort Scope="public" Binding="dynamic" Target="#CFCDocHeaderDocumentorDocumentInternal">
<Name>DocumentInternal</Name>
<Description>
Here should be a short description of the function.
</Description>
</MethodShort>
<MethodShort Scope="public" Binding="dynamic" Target="#CFCDocHeaderDocumentorLocateHTMLFile">
<Name>LocateHTMLFile</Name>
<Description>
Here should be a short description of the function.
</Description>
</MethodShort>
<MethodShort Scope="public" Binding="dynamic" Target="#CFCDocHeaderDocumentorLocateXMLFile">
<Name>LocateXMLFile</Name>
<Description>
Here should be a short description of the function.
</Description>
</MethodShort>
<MethodShort Scope="private" Binding="dynamic" Target="#CFCDocHeaderDocumentorScanXMLFile">
<Name>ScanXMLFile</Name>
<Description>
Here should be a short description of the function.
</Description>
</MethodShort>
<MethodShort Scope="public" Binding="dynamic" Target="#CFCDocHeaderDocumentorOnNewDocument">
<Name>OnNewDocument</Name>
<Description>
Here should be a short description of the function.
</Description>
</MethodShort>
<MethodShort Scope="public" Binding="dynamic" Target="#CFCDocHeaderDocumentorSerialize">
<Name>Serialize</Name>
<Description>
Here should be a short description of the function.
</Description>
</MethodShort>
<MethodShort Scope="public" Binding="dynamic" Target="#CFCDocHeaderDocumentor_CDocHeaderDocumentor">
<Name>~CDocHeaderDocumentor</Name>
<Description>
Here should be a short description of the function.
</Description>
</MethodShort>
<MethodShort Scope="public" Binding="dynamic" Target="#CFCDocHeaderDocumentorAssertValid">
<Name>AssertValid</Name>
<Description>
Here should be a short description of the function.
</Description>
</MethodShort>
<MethodShort Scope="public" Binding="dynamic" Target="#CFCDocHeaderDocumentorDump">
<Name>Dump</Name>
<Description>
Here should be a short description of the function.
</Description>
</MethodShort>
<MethodShort Scope="public" Binding="dynamic" Target="#CFCDocHeaderDocumentorReadHeaderFile">
<Name>ReadHeaderFile</Name>
<Description>
Here should be a short description of the function.
</Description>
</MethodShort>
<MethodShort Scope="public" Binding="dynamic" Target="#CFCDocHeaderDocumentorMakeOutputHTML">
<Name>MakeOutputHTML</Name>
<Description>
Here should be a short description of the function.
</Description>
</MethodShort>
<MethodShort Scope="public" Binding="dynamic" Target="#CFCDocHeaderDocumentorMakeOutputXML">
<Name>MakeOutputXML</Name>
<Description>
Here should be a short description of the function.
</Description>
</MethodShort>
<MethodShort Scope="protected" Binding="dynamic" Target="#CFCDocHeaderDocumentorOnFileOpen">
<Name>OnFileOpen</Name>
<Description>
Here should be a short description of the function.
</Description>
</MethodShort>
<MethodShort Scope="protected" Binding="dynamic" Target="#CFCDocHeaderDocumentorOnSaveFileXML">
<Name>OnSaveFileXML</Name>
<Description>
Here should be a short description of the function.
</Description>
</MethodShort>
<MethodShort Scope="protected" Binding="dynamic" Target="#CFCDocHeaderDocumentorOnSaveFileHTML">
<Name>OnSaveFileHTML</Name>
<Description>
Here should be a short description of the function.
</Description>
</MethodShort>
<MethodShort Scope="protected" Binding="dynamic" Target="#CFCDocHeaderDocumentorOnUpdateSaveFileHTML">
<Name>OnUpdateSaveFileHTML</Name>
<Description>
Here should be a short description of the function.
</Description>
</MethodShort>
<MethodShort Scope="protected" Binding="dynamic" Target="#CFCDocHeaderDocumentorOnUpdateSaveFileXML">
<Name>OnUpdateSaveFileXML</Name>
<Description>
Here should be a short description of the function.
</Description>
</MethodShort>
<MethodShort Scope="protected" Binding="dynamic" Target="#CFCDocHeaderDocumentorOnFileReadXml">
<Name>OnFileReadXml</Name>
<Description>
Here should be a short description of the function.
</Description>
</MethodShort>
<MethodShort Scope="protected" Binding="dynamic" Target="#CFCDocHeaderDocumentorOnUpdateFileReadXml">
<Name>OnUpdateFileReadXml</Name>
<Description>
Here should be a short description of the function.
</Description>
</MethodShort>
</MethodsShort>
</MethodsList>
<Methods>
<Method anchor="CFCDocHeaderDocumentorReadIniFile" NAME="CFCDocHeaderDocumentorReadIniFile">
<Header>
static bool ReadIniFile(const CString strIniFileName);
</Header>
<ReturnValues>
<Header>Return values</Header>
<ReturnValue>
<Name>bool</Name>
<Description>
Here should be a description of the return value.
</Description>
</ReturnValue>
</ReturnValues>
<Parameters>
<Header>Parameter</Header>
<Parameter>
<Name>const CString strIniFileName</Name>
<Description>
Here should be a description of the parameter
</Description>
</Parameter>
</Parameters>
<Description>
Here should be a detailed description of the function.
</Description>
</Method>
<Method anchor="CFCDocHeaderDocumentorCDocHeaderDocumentor" NAME="CFCDocHeaderDocumentorCDocHeaderDocumentor">
<Header>
CDocHeaderDocumentor();
</Header>
<ReturnValues>
<Header>Return values</Header>
<ReturnValue>
<Name>int (DEFAULT)</Name>
<Description>
Here should be a description of the return value.
</Description>
</ReturnValue>
</ReturnValues>
<Parameters>
<Header>Parameter</Header>
<Parameter>
<Name>void</Name>
<Description>
 - none -
</Description>
</Parameter>
</Parameters>
<Description>
Here should be a detailed description of the function.
</Description>
</Method>
<Method anchor="CFCDocHeaderDocumentorGetTextArray" NAME="CFCDocHeaderDocumentorGetTextArray">
<Header>
CStringArray&amp; GetTextArray(void);
</Header>
<ReturnValues>
<Header>Return values</Header>
<ReturnValue>
<Name>CStringArray&amp;</Name>
<Description>
Here should be a description of the return value.
</Description>
</ReturnValue>
</ReturnValues>
<Parameters>
<Header>Parameter</Header>
<Parameter>
<Name>void</Name>
<Description>
 - none -
</Description>
</Parameter>
</Parameters>
<Description>
Here should be a detailed description of the function.
</Description>
</Method>
<Method anchor="CFCDocHeaderDocumentorIsHeaderRead" NAME="CFCDocHeaderDocumentorIsHeaderRead">
<Header>
bool IsHeaderRead(void) const;
</Header>
<ReturnValues>
<Header>Return values</Header>
<ReturnValue>
<Name>bool</Name>
<Description>
Here should be a description of the return value.
</Description>
</ReturnValue>
</ReturnValues>
<Parameters>
<Header>Parameter</Header>
<Parameter>
<Name>void</Name>
<Description>
 - none -
</Description>
</Parameter>
</Parameters>
<Description>
Here should be a detailed description of the function.
</Description>
</Method>
<Method anchor="CFCDocHeaderDocumentorCreateKeywords" NAME="CFCDocHeaderDocumentorCreateKeywords">
<Header>
bool CreateKeywords(void) const;
</Header>
<Header>
void CreateKeywords(bool bCreateKeywords);
</Header>
<ReturnValues>
<Header>Return values</Header>
<ReturnValue>
<Name>bool</Name>
<Description>
Here should be a description of the return value.
</Description>
</ReturnValue>
<ReturnValue>
<Name>void</Name>
<Description>
 - none -
</Description>
</ReturnValue>
</ReturnValues>
<Parameters>
<Header>Parameter</Header>
<Parameter>
<Name>void</Name>
<Description>
 - none -
</Description>
</Parameter>
<Parameter>
<Name>bool bCreateKeywords</Name>
<Description>
Here should be a description of the parameter
</Description>
</Parameter>
</Parameters>
<Description>
Here should be a detailed description of the function.
</Description>
</Method>
<Method anchor="CFCDocHeaderDocumentorCreateSplitfiles" NAME="CFCDocHeaderDocumentorCreateSplitfiles">
<Header>
bool CreateSplitfiles(void) const;
</Header>
<Header>
void CreateSplitfiles(bool bCreateSplitfiles);
</Header>
<ReturnValues>
<Header>Return values</Header>
<ReturnValue>
<Name>bool</Name>
<Description>
Here should be a description of the return value.
</Description>
</ReturnValue>
<ReturnValue>
<Name>void</Name>
<Description>
 - none -
</Description>
</ReturnValue>
</ReturnValues>
<Parameters>
<Header>Parameter</Header>
<Parameter>
<Name>void</Name>
<Description>
 - none -
</Description>
</Parameter>
<Parameter>
<Name>bool bCreateSplitfiles</Name>
<Description>
Here should be a description of the parameter
</Description>
</Parameter>
</Parameters>
<Description>
Here should be a detailed description of the function.
</Description>
</Method>
<Method anchor="CFCDocHeaderDocumentorUseStyleSheet" NAME="CFCDocHeaderDocumentorUseStyleSheet">
<Header>
bool UseStyleSheet(void) const;
</Header>
<Header>
void UseStyleSheet(bool bUseStyleSheet);
</Header>
<ReturnValues>
<Header>Return values</Header>
<ReturnValue>
<Name>bool</Name>
<Description>
Here should be a description of the return value.
</Description>
</ReturnValue>
<ReturnValue>
<Name>void</Name>
<Description>
 - none -
</Description>
</ReturnValue>
</ReturnValues>
<Parameters>
<Header>Parameter</Header>
<Parameter>
<Name>void</Name>
<Description>
 - none -
</Description>
</Parameter>
<Parameter>
<Name>bool bUseStyleSheet</Name>
<Description>
Here should be a description of the parameter
</Description>
</Parameter>
</Parameters>
<Description>
Here should be a detailed description of the function.
</Description>
</Method>
<Method anchor="CFCDocHeaderDocumentorDocumentPublic" NAME="CFCDocHeaderDocumentorDocumentPublic">
<Header>
bool DocumentPublic(void) const;
</Header>
<Header>
void DocumentPublic(bool bDocumentPublic);
</Header>
<ReturnValues>
<Header>Return values</Header>
<ReturnValue>
<Name>bool</Name>
<Description>
Here should be a description of the return value.
</Description>
</ReturnValue>
<ReturnValue>
<Name>void</Name>
<Description>
 - none -
</Description>
</ReturnValue>
</ReturnValues>
<Parameters>
<Header>Parameter</Header>
<Parameter>
<Name>void</Name>
<Description>
 - none -
</Description>
</Parameter>
<Parameter>
<Name>bool bDocumentPublic</Name>
<Description>
Here should be a description of the parameter
</Description>
</Parameter>
</Parameters>
<Description>
Here should be a detailed description of the function.
</Description>
</Method>
<Method anchor="CFCDocHeaderDocumentorDocumentProtected" NAME="CFCDocHeaderDocumentorDocumentProtected">
<Header>
bool DocumentProtected(void) const;
</Header>
<Header>
void DocumentProtected(bool bDocumentProtected);
</Header>
<ReturnValues>
<Header>Return values</Header>
<ReturnValue>
<Name>bool</Name>
<Description>
Here should be a description of the return value.
</Description>
</ReturnValue>
<ReturnValue>
<Name>void</Name>
<Description>
 - none -
</Description>
</ReturnValue>
</ReturnValues>
<Parameters>
<Header>Parameter</Header>
<Parameter>
<Name>void</Name>
<Description>
 - none -
</Description>
</Parameter>
<Parameter>
<Name>bool bDocumentProtected</Name>
<Description>
Here should be a description of the parameter
</Description>
</Parameter>
</Parameters>
<Description>
Here should be a detailed description of the function.
</Description>
</Method>
<Method anchor="CFCDocHeaderDocumentorDocumentPrivate" NAME="CFCDocHeaderDocumentorDocumentPrivate">
<Header>
bool DocumentPrivate(void) const;
</Header>
<Header>
void DocumentPrivate(bool bDocumentPrivate);
</Header>
<ReturnValues>
<Header>Return values</Header>
<ReturnValue>
<Name>bool</Name>
<Description>
Here should be a description of the return value.
</Description>
</ReturnValue>
<ReturnValue>
<Name>void</Name>
<Description>
 - none -
</Description>
</ReturnValue>
</ReturnValues>
<Parameters>
<Header>Parameter</Header>
<Parameter>
<Name>void</Name>
<Description>
 - none -
</Description>
</Parameter>
<Parameter>
<Name>bool bDocumentPrivate</Name>
<Description>
Here should be a description of the parameter
</Description>
</Parameter>
</Parameters>
<Description>
Here should be a detailed description of the function.
</Description>
</Method>
<Method anchor="CFCDocHeaderDocumentorDocumentExternal" NAME="CFCDocHeaderDocumentorDocumentExternal">
<Header>
bool DocumentExternal(void) const;
</Header>
<Header>
void DocumentExternal(bool bDocumentExternal);
</Header>
<ReturnValues>
<Header>Return values</Header>
<ReturnValue>
<Name>bool</Name>
<Description>
Here should be a description of the return value.
</Description>
</ReturnValue>
<ReturnValue>
<Name>void</Name>
<Description>
 - none -
</Description>
</ReturnValue>
</ReturnValues>
<Parameters>
<Header>Parameter</Header>
<Parameter>
<Name>void</Name>
<Description>
 - none -
</Description>
</Parameter>
<Parameter>
<Name>bool bDocumentExternal</Name>
<Description>
Here should be a description of the parameter
</Description>
</Parameter>
</Parameters>
<Description>
Here should be a detailed description of the function.
</Description>
</Method>
<Method anchor="CFCDocHeaderDocumentorDocumentInternal" NAME="CFCDocHeaderDocumentorDocumentInternal">
<Header>
bool DocumentInternal(void) const;
</Header>
<Header>
void DocumentInternal(bool bDocumentInternal);
</Header>
<ReturnValues>
<Header>Return values</Header>
<ReturnValue>
<Name>bool</Name>
<Description>
Here should be a description of the return value.
</Description>
</ReturnValue>
<ReturnValue>
<Name>void</Name>
<Description>
 - none -
</Description>
</ReturnValue>
</ReturnValues>
<Parameters>
<Header>Parameter</Header>
<Parameter>
<Name>void</Name>
<Description>
 - none -
</Description>
</Parameter>
<Parameter>
<Name>bool bDocumentInternal</Name>
<Description>
Here should be a description of the parameter
</Description>
</Parameter>
</Parameters>
<Description>
Here should be a detailed description of the function.
</Description>
</Method>
<Method anchor="CFCDocHeaderDocumentorLocateHTMLFile" NAME="CFCDocHeaderDocumentorLocateHTMLFile">
<Header>
void LocateHTMLFile(void);
</Header>
<ReturnValues>
<Header>Return values</Header>
<ReturnValue>
<Name>void</Name>
<Description>
 - none -
</Description>
</ReturnValue>
</ReturnValues>
<Parameters>
<Header>Parameter</Header>
<Parameter>
<Name>void</Name>
<Description>
 - none -
</Description>
</Parameter>
</Parameters>
<Description>
Here should be a detailed description of the function.
</Description>
</Method>
<Method anchor="CFCDocHeaderDocumentorLocateXMLFile" NAME="CFCDocHeaderDocumentorLocateXMLFile">
<Header>
void LocateXMLFile(void);
</Header>
<ReturnValues>
<Header>Return values</Header>
<ReturnValue>
<Name>void</Name>
<Description>
 - none -
</Description>
</ReturnValue>
</ReturnValues>
<Parameters>
<Header>Parameter</Header>
<Parameter>
<Name>void</Name>
<Description>
 - none -
</Description>
</Parameter>
</Parameters>
<Description>
Here should be a detailed description of the function.
</Description>
</Method>
<Method anchor="CFCDocHeaderDocumentorScanXMLFile" NAME="CFCDocHeaderDocumentorScanXMLFile">
<Header>
bool ScanXMLFile(void);
</Header>
<ReturnValues>
<Header>Return values</Header>
<ReturnValue>
<Name>bool</Name>
<Description>
Here should be a description of the return value.
</Description>
</ReturnValue>
</ReturnValues>
<Parameters>
<Header>Parameter</Header>
<Parameter>
<Name>void</Name>
<Description>
 - none -
</Description>
</Parameter>
</Parameters>
<Description>
Here should be a detailed description of the function.
</Description>
</Method>
<Method anchor="CFCDocHeaderDocumentorOnNewDocument" NAME="CFCDocHeaderDocumentorOnNewDocument">
<Header>
virtual BOOL OnNewDocument();
</Header>
<ReturnValues>
<Header>Return values</Header>
<ReturnValue>
<Name>BOOL</Name>
<Description>
Here should be a description of the return value.
</Description>
</ReturnValue>
</ReturnValues>
<Parameters>
<Header>Parameter</Header>
<Parameter>
<Name>void</Name>
<Description>
 - none -
</Description>
</Parameter>
</Parameters>
<Description>
Here should be a detailed description of the function.
</Description>
</Method>
<Method anchor="CFCDocHeaderDocumentorSerialize" NAME="CFCDocHeaderDocumentorSerialize">
<Header>
virtual void Serialize(CArchive&amp; ar);
</Header>
<ReturnValues>
<Header>Return values</Header>
<ReturnValue>
<Name>void</Name>
<Description>
 - none -
</Description>
</ReturnValue>
</ReturnValues>
<Parameters>
<Header>Parameter</Header>
<Parameter>
<Name>CArchive&amp; ar</Name>
<Description>
Here should be a description of the parameter
</Description>
</Parameter>
</Parameters>
<Description>
Here should be a detailed description of the function.
</Description>
</Method>
<Method anchor="CFCDocHeaderDocumentor_CDocHeaderDocumentor" NAME="CFCDocHeaderDocumentor_CDocHeaderDocumentor">
<Header>
virtual ~CDocHeaderDocumentor();
</Header>
<ReturnValues>
<Header>Return values</Header>
</ReturnValues>
<Parameters>
<Header>Parameter</Header>
<Parameter>
<Name>void</Name>
<Description>
 - none -
</Description>
</Parameter>
</Parameters>
<Description>
Here should be a detailed description of the function.
</Description>
</Method>
<Method anchor="CFCDocHeaderDocumentorAssertValid" NAME="CFCDocHeaderDocumentorAssertValid">
<Header>
virtual void AssertValid() const;
</Header>
<ReturnValues>
<Header>Return values</Header>
<ReturnValue>
<Name>void</Name>
<Description>
 - none -
</Description>
</ReturnValue>
</ReturnValues>
<Parameters>
<Header>Parameter</Header>
<Parameter>
<Name>void</Name>
<Description>
 - none -
</Description>
</Parameter>
</Parameters>
<Description>
Here should be a detailed description of the function.
</Description>
</Method>
<Method anchor="CFCDocHeaderDocumentorDump" NAME="CFCDocHeaderDocumentorDump">
<Header>
virtual void Dump(CDumpContext&amp; dc) const;
</Header>
<ReturnValues>
<Header>Return values</Header>
<ReturnValue>
<Name>void</Name>
<Description>
 - none -
</Description>
</ReturnValue>
</ReturnValues>
<Parameters>
<Header>Parameter</Header>
<Parameter>
<Name>CDumpContext&amp; dc</Name>
<Description>
Here should be a description of the parameter
</Description>
</Parameter>
</Parameters>
<Description>
Here should be a detailed description of the function.
</Description>
</Method>
<Method anchor="CFCDocHeaderDocumentorReadHeaderFile" NAME="CFCDocHeaderDocumentorReadHeaderFile">
<Header>
bool ReadHeaderFile(void);
</Header>
<ReturnValues>
<Header>Return values</Header>
<ReturnValue>
<Name>bool</Name>
<Description>
Here should be a description of the return value.
</Description>
</ReturnValue>
</ReturnValues>
<Parameters>
<Header>Parameter</Header>
<Parameter>
<Name>void</Name>
<Description>
 - none -
</Description>
</Parameter>
</Parameters>
<Description>
Here should be a detailed description of the function.
</Description>
</Method>
<Method anchor="CFCDocHeaderDocumentorMakeOutputHTML" NAME="CFCDocHeaderDocumentorMakeOutputHTML">
<Header>
bool MakeOutputHTML(void);
</Header>
<ReturnValues>
<Header>Return values</Header>
<ReturnValue>
<Name>bool</Name>
<Description>
Here should be a description of the return value.
</Description>
</ReturnValue>
</ReturnValues>
<Parameters>
<Header>Parameter</Header>
<Parameter>
<Name>void</Name>
<Description>
 - none -
</Description>
</Parameter>
</Parameters>
<Description>
Here should be a detailed description of the function.
</Description>
</Method>
<Method anchor="CFCDocHeaderDocumentorMakeOutputXML" NAME="CFCDocHeaderDocumentorMakeOutputXML">
<Header>
bool MakeOutputXML(void);
</Header>
<ReturnValues>
<Header>Return values</Header>
<ReturnValue>
<Name>bool</Name>
<Description>
Here should be a description of the return value.
</Description>
</ReturnValue>
</ReturnValues>
<Parameters>
<Header>Parameter</Header>
<Parameter>
<Name>void</Name>
<Description>
 - none -
</Description>
</Parameter>
</Parameters>
<Description>
Here should be a detailed description of the function.
</Description>
</Method>
<Method anchor="CFCDocHeaderDocumentorOnFileOpen" NAME="CFCDocHeaderDocumentorOnFileOpen">
<Header>
afx_msg void OnFileOpen();
</Header>
<ReturnValues>
<Header>Return values</Header>
<ReturnValue>
<Name>void</Name>
<Description>
 - none -
</Description>
</ReturnValue>
</ReturnValues>
<Parameters>
<Header>Parameter</Header>
<Parameter>
<Name>void</Name>
<Description>
 - none -
</Description>
</Parameter>
</Parameters>
<Description>
Here should be a detailed description of the function.
</Description>
</Method>
<Method anchor="CFCDocHeaderDocumentorOnSaveFileXML" NAME="CFCDocHeaderDocumentorOnSaveFileXML">
<Header>
afx_msg void OnSaveFileXML();
</Header>
<ReturnValues>
<Header>Return values</Header>
<ReturnValue>
<Name>void</Name>
<Description>
 - none -
</Description>
</ReturnValue>
</ReturnValues>
<Parameters>
<Header>Parameter</Header>
<Parameter>
<Name>void</Name>
<Description>
 - none -
</Description>
</Parameter>
</Parameters>
<Description>
Here should be a detailed description of the function.
</Description>
</Method>
<Method anchor="CFCDocHeaderDocumentorOnSaveFileHTML" NAME="CFCDocHeaderDocumentorOnSaveFileHTML">
<Header>
afx_msg void OnSaveFileHTML();
</Header>
<ReturnValues>
<Header>Return values</Header>
<ReturnValue>
<Name>void</Name>
<Description>
 - none -
</Description>
</ReturnValue>
</ReturnValues>
<Parameters>
<Header>Parameter</Header>
<Parameter>
<Name>void</Name>
<Description>
 - none -
</Description>
</Parameter>
</Parameters>
<Description>
Here should be a detailed description of the function.
</Description>
</Method>
<Method anchor="CFCDocHeaderDocumentorOnUpdateSaveFileHTML" NAME="CFCDocHeaderDocumentorOnUpdateSaveFileHTML">
<Header>
afx_msg void OnUpdateSaveFileHTML(CCmdUI* pCmdUI);
</Header>
<ReturnValues>
<Header>Return values</Header>
<ReturnValue>
<Name>void</Name>
<Description>
 - none -
</Description>
</ReturnValue>
</ReturnValues>
<Parameters>
<Header>Parameter</Header>
<Parameter>
<Name>CCmdUI* pCmdUI</Name>
<Description>
Here should be a description of the parameter
</Description>
</Parameter>
</Parameters>
<Description>
Here should be a detailed description of the function.
</Description>
</Method>
<Method anchor="CFCDocHeaderDocumentorOnUpdateSaveFileXML" NAME="CFCDocHeaderDocumentorOnUpdateSaveFileXML">
<Header>
afx_msg void OnUpdateSaveFileXML(CCmdUI* pCmdUI);
</Header>
<ReturnValues>
<Header>Return values</Header>
<ReturnValue>
<Name>void</Name>
<Description>
 - none -
</Description>
</ReturnValue>
</ReturnValues>
<Parameters>
<Header>Parameter</Header>
<Parameter>
<Name>CCmdUI* pCmdUI</Name>
<Description>
Here should be a description of the parameter
</Description>
</Parameter>
</Parameters>
<Description>
Here should be a detailed description of the function.
</Description>
</Method>
<Method anchor="CFCDocHeaderDocumentorOnFileReadXml" NAME="CFCDocHeaderDocumentorOnFileReadXml">
<Header>
afx_msg void OnFileReadXml();
</Header>
<ReturnValues>
<Header>Return values</Header>
<ReturnValue>
<Name>void</Name>
<Description>
 - none -
</Description>
</ReturnValue>
</ReturnValues>
<Parameters>
<Header>Parameter</Header>
<Parameter>
<Name>void</Name>
<Description>
 - none -
</Description>
</Parameter>
</Parameters>
<Description>
Here should be a detailed description of the function.
</Description>
</Method>
<Method anchor="CFCDocHeaderDocumentorOnUpdateFileReadXml" NAME="CFCDocHeaderDocumentorOnUpdateFileReadXml">
<Header>
afx_msg void OnUpdateFileReadXml(CCmdUI* pCmdUI);
</Header>
<ReturnValues>
<Header>Return values</Header>
<ReturnValue>
<Name>void</Name>
<Description>
 - none -
</Description>
</ReturnValue>
</ReturnValues>
<Parameters>
<Header>Parameter</Header>
<Parameter>
<Name>CCmdUI* pCmdUI</Name>
<Description>
Here should be a description of the parameter
</Description>
</Parameter>
</Parameters>
<Description>
Here should be a detailed description of the function.
</Description>
</Method>
</Methods>
</Class>
</HDocumentor>

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