Click here to Skip to main content
15,884,836 members
Search within:


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="ModulCreateOutputHTML" NAME="ModulCreateOutputHTML" class="Technik">
<Module.Title>CreateOutputHTML</Module.Title>
<Module.Description>
<Text>
This file contains functions to ease the creation of a HTML file, out of the stored information.<br/>
</Text>
<Statistics>
<Line1>The module CreateOutputHTML contains no global variables.</Line1>
</Statistics>
<Statistics>
<Line1>The module CreateOutputHTML contains 8 global functions.</Line1>
<Line2>8 functions have external binding.</Line2>
</Statistics>
<Statistics>
<Line1>The module CreateOutputHTML contains no class definition.</Line1>
</Statistics>
<HIncludesList>
<Header>Included files by CreateOutputHTML.h:</Header>
<HIncludes>
<HInclude>&quot;ModulHelpers.h&quot;</HInclude>
</HIncludes>
</HIncludesList>
<CPPIncludesList>
<Header>Included files by CreateOutputHTML.cpp:</Header>
<CPPIncludes>
<CPPInclude>&quot;stdafx.h&quot;</CPPInclude>
<CPPInclude>&quot;CreateOutputHTML.h&quot;</CPPInclude>
<CPPInclude>&quot;TextStrings.h&quot;</CPPInclude>
<CPPInclude>&quot;TextStringsHTML.h&quot;</CPPInclude>
<CPPInclude>&quot;TextStringsXML.h&quot;</CPPInclude>
</CPPIncludes>
</CPPIncludesList>
</Module.Description>
<Module.FunctionList anchor="ModulCreateOutputHTMLGF" NAME="ModulCreateOutputHTMLGF">
<Header>Global functions:</Header>
<Description>This is the list of global functions.</Description>
<FunctionsShort>
<FunctionShort Scope="global" Binding="extern" Target="#GFConvertTextToHTML">
<Name>ConvertTextToHTML</Name>
<Description>
Converts a text string to HTML spelling.
</Description>
</FunctionShort>
<FunctionShort Scope="global" Binding="extern" Target="#GFMakeLinkList">
<Name>MakeLinkList</Name>
<Description>
Creates a link list for use in the HTML file.
</Description>
</FunctionShort>
<FunctionShort Scope="global" Binding="extern" Target="#GFMakeHTML_Head">
<Name>MakeHTML_Head</Name>
<Description>
Creates the first (Head) part of a HTML file.
</Description>
</FunctionShort>
<FunctionShort Scope="global" Binding="extern" Target="#GFMakeHTML_FirstPart">
<Name>MakeHTML_FirstPart</Name>
<Description>
Creates the first part (mainly statistics) for the HTML file.
</Description>
</FunctionShort>
<FunctionShort Scope="global" Binding="extern" Target="#GFMakeHTML_GlobalVariables">
<Name>MakeHTML_GlobalVariables</Name>
<Description>
Creates the output for global variables of the HTML file.
</Description>
</FunctionShort>
<FunctionShort Scope="global" Binding="extern" Target="#GFMakeHTML_GlobalFunctions">
<Name>MakeHTML_GlobalFunctions</Name>
<Description>
Creates the output for global functions of the HTML file.
</Description>
</FunctionShort>
<FunctionShort Scope="global" Binding="extern" Target="#GFMakeHTML_Class">
<Name>MakeHTML_Class</Name>
<Description>
Creates the output for the classes of the HTML file.
</Description>
</FunctionShort>
<FunctionShort Scope="global" Binding="extern" Target="#GFMakeHTML_Foot">
<Name>MakeHTML_Foot</Name>
<Description>
Creates the last lines of the HTML file.
</Description>
</FunctionShort>
</FunctionsShort>
</Module.FunctionList>
<Module.Functions>
<ModuleFunction anchor="GFConvertTextToHTML" NAME="GFConvertTextToHTML">
<Header>
void ConvertTextToHTML(CString&amp; strText);
</Header>
<ReturnValues>
<Header>Return values</Header>
<ReturnValue>
<Name>void</Name>
<Description>
 - none -
</Description>
</ReturnValue>
</ReturnValues>
<Parameters>
<Header>Parameter</Header>
<Parameter>
<Name>CString&amp; strText</Name>
<Description>
Here should be a description of the parameter
</Description>
</Parameter>
</Parameters>
<Description>
Here should be a detailed description of the function.
</Description>
</ModuleFunction>
<ModuleFunction anchor="GFMakeLinkList" NAME="GFMakeLinkList">
<Header>
void MakeLinkList(CStringArray&amp; astrOutput, const SModul&amp; sParameters);
</Header>
<ReturnValues>
<Header>Return values</Header>
<ReturnValue>
<Name>void</Name>
<Description>
 - none -
</Description>
</ReturnValue>
</ReturnValues>
<Parameters>
<Header>Parameter</Header>
<Parameter>
<Name>CStringArray&amp; astrOutput</Name>
<Description>
Here should be a description of the parameter
</Description>
</Parameter>
<Parameter>
<Name>const SModul&amp; sParameters</Name>
<Description>
Here should be a description of the parameter
</Description>
</Parameter>
</Parameters>
<Description>
Here should be a detailed description of the function.
</Description>
</ModuleFunction>
<ModuleFunction anchor="GFMakeHTML_Head" NAME="GFMakeHTML_Head">
<Header>
void MakeHTML_Head(CStringArray&amp; astrOutput, const SModul&amp; sParameters);
</Header>
<ReturnValues>
<Header>Return values</Header>
<ReturnValue>
<Name>void</Name>
<Description>
 - none -
</Description>
</ReturnValue>
</ReturnValues>
<Parameters>
<Header>Parameter</Header>
<Parameter>
<Name>CStringArray&amp; astrOutput</Name>
<Description>
Here should be a description of the parameter
</Description>
</Parameter>
<Parameter>
<Name>const SModul&amp; sParameters</Name>
<Description>
Here should be a description of the parameter
</Description>
</Parameter>
</Parameters>
<Description>
Here should be a detailed description of the function.
</Description>
</ModuleFunction>
<ModuleFunction anchor="GFMakeHTML_FirstPart" NAME="GFMakeHTML_FirstPart">
<Header>
void MakeHTML_FirstPart(CStringArray&amp; astrOutput, const SModul&amp; sParameters);
</Header>
<ReturnValues>
<Header>Return values</Header>
<ReturnValue>
<Name>void</Name>
<Description>
 - none -
</Description>
</ReturnValue>
</ReturnValues>
<Parameters>
<Header>Parameter</Header>
<Parameter>
<Name>CStringArray&amp; astrOutput</Name>
<Description>
Here should be a description of the parameter
</Description>
</Parameter>
<Parameter>
<Name>const SModul&amp; sParameters</Name>
<Description>
Here should be a description of the parameter
</Description>
</Parameter>
</Parameters>
<Description>
Here should be a detailed description of the function.
</Description>
</ModuleFunction>
<ModuleFunction anchor="GFMakeHTML_GlobalVariables" NAME="GFMakeHTML_GlobalVariables">
<Header>
void MakeHTML_GlobalVariables(CStringArray&amp; astrOutput, const SModul&amp; sParameters);
</Header>
<ReturnValues>
<Header>Return values</Header>
<ReturnValue>
<Name>void</Name>
<Description>
 - none -
</Description>
</ReturnValue>
</ReturnValues>
<Parameters>
<Header>Parameter</Header>
<Parameter>
<Name>CStringArray&amp; astrOutput</Name>
<Description>
Here should be a description of the parameter
</Description>
</Parameter>
<Parameter>
<Name>const SModul&amp; sParameters</Name>
<Description>
Here should be a description of the parameter
</Description>
</Parameter>
</Parameters>
<Description>
Here should be a detailed description of the function.
</Description>
</ModuleFunction>
<ModuleFunction anchor="GFMakeHTML_GlobalFunctions" NAME="GFMakeHTML_GlobalFunctions">
<Header>
void MakeHTML_GlobalFunctions(CStringArray&amp; astrOutput, const SModul&amp; sParameters);
</Header>
<ReturnValues>
<Header>Return values</Header>
<ReturnValue>
<Name>void</Name>
<Description>
 - none -
</Description>
</ReturnValue>
</ReturnValues>
<Parameters>
<Header>Parameter</Header>
<Parameter>
<Name>CStringArray&amp; astrOutput</Name>
<Description>
Here should be a description of the parameter
</Description>
</Parameter>
<Parameter>
<Name>const SModul&amp; sParameters</Name>
<Description>
Here should be a description of the parameter
</Description>
</Parameter>
</Parameters>
<Description>
Here should be a detailed description of the function.
</Description>
</ModuleFunction>
<ModuleFunction anchor="GFMakeHTML_Class" NAME="GFMakeHTML_Class">
<Header>
void MakeHTML_Class(CStringArray&amp; astrOutput, const CString strClassname, const SModul&amp; sParameters);
</Header>
<ReturnValues>
<Header>Return values</Header>
<ReturnValue>
<Name>void</Name>
<Description>
 - none -
</Description>
</ReturnValue>
</ReturnValues>
<Parameters>
<Header>Parameter</Header>
<Parameter>
<Name>CStringArray&amp; astrOutput</Name>
<Description>
Here should be a description of the parameter
</Description>
</Parameter>
<Parameter>
<Name>const CString strClassname</Name>
<Description>
Here should be a description of the parameter
</Description>
</Parameter>
<Parameter>
<Name>const SModul&amp; sParameters</Name>
<Description>
Here should be a description of the parameter
</Description>
</Parameter>
</Parameters>
<Description>
Here should be a detailed description of the function.
</Description>
</ModuleFunction>
<ModuleFunction anchor="GFMakeHTML_Foot" NAME="GFMakeHTML_Foot">
<Header>
void MakeHTML_Foot(CStringArray&amp; astrOutput, const SModul&amp; sParameters);
</Header>
<ReturnValues>
<Header>Return values</Header>
<ReturnValue>
<Name>void</Name>
<Description>
 - none -
</Description>
</ReturnValue>
</ReturnValues>
<Parameters>
<Header>Parameter</Header>
<Parameter>
<Name>CStringArray&amp; astrOutput</Name>
<Description>
Here should be a description of the parameter
</Description>
</Parameter>
<Parameter>
<Name>const SModul&amp; sParameters</Name>
<Description>
Here should be a description of the parameter
</Description>
</Parameter>
</Parameters>
<Description>
Here should be a detailed description of the function.
</Description>
</ModuleFunction>
</Module.Functions>
</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
G. Steudtel
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

Permalink
Advertise
Privacy
Cookies
Terms of Use
Layout: fixed | fluid

Posted 16 Sep 2003

Article Copyright 2003 by G. Steudtel
Everything else Copyright © CodeProject, 1999-2024

Web03 2.8:2024-04-02:1