Documenting Header Files

G. Steudtel

Rate me:

2.95/5 (14 votes)

16 Sep 2003CPOL6 min read

63.7K

846

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.

headerdocumentor_src.zip
- HeaderDocumentor
  - CreateOutpuHTML.cpp
  - CreateOutputHTML.h
  - CreateOutputXML.cpp
  - CreateOutputXML.h
  - CStringHelpers.cpp
  - CStringHelpers.h
  - DocHeaderDocumentor.cpp
  - DocHeaderDocumentor.h
  - HeaderDocumentor.chm
  - HeaderDocumentor.clw
  - HeaderDocumentor.cpp
  - HeaderDocumentor.dsp
  - HeaderDocumentor.dsw
  - HeaderDocumentor.h
  - HeaderDocumentor.ini
  - HeaderDocumentor.rc
  - Html
    - Documentation
    - FairyTale.htm
    - HDocumentor.css
    - HeaderDoc.log
    - HeaderDocumentor.chm
    - HeaderDocumentor.hhp
    - HeaderDocumentor.htm
    - IMAGES
      - HeaderDocumentorForm.gif
    - Index.hhk
    - Table of Contents.hhc
    - TheProgram.htm
    - TipsAndTricks.htm
  - HTMLHELP.H
  - HTMLHELP.LIB
  - MainFrame.cpp
  - MainFrame.h
  - MarkupHelpers.cpp
  - MarkupHelpers.h
  - ModulHelpers.cpp
  - ModulHelpers.h
  - Release
    - HDocumentor.css
    - HDocumentor.dtd
    - HDocumentor.xsl
    - HeaderDocumentor.chm
    - HeaderDocumentor.exe
    - HeaderDocumentor.ini
  - RES
    - DocHeaderDocumentor.ico
    - HeaderDocumentor.ico
    - HeaderDocumentor.rc2
    - Toolbar.bmp
  - RESOURCE.H
  - RESOURCE.HM
  - StdAfx.cpp
  - StdAfx.h
  - TextStrings.cpp
  - TextStrings.h
  - TextStringsHTML.cpp
  - TextStringsHTML.h
  - TextStringsXML.cpp
  - TextStringsXML.h
  - ViewHeaderDocumentor.cpp
  - ViewHeaderDocumentor.h
headerdocumentor_demo.zip
- HDocumentor.css
- HDocumentor.dtd
- HDocumentor.xsl
- HeaderDocumentor.chm
- HeaderDocumentor.exe
- HeaderDocumentor.ini

// Helperfile for scanning the XML input

#if !defined(_MARKUPHELPERS_INCLUDED_)
#define _MARKUPHELPERS_INCLUDED_

#include "ModulHelpers.h"
#include "Markup.h"

// scan for the module part
void ScanXMLForModule(CMarkup& xmlMarkup, SModul* smModule);
void ScanXMLForGlobalVariables(CMarkup& xmlMarkup, SModul* smModule);
void ScanXMLForGlobalFunctions(CMarkup& xmlMarkup, SModul* smModule);
void ScanXMLForClasses(CMarkup& xmlMarkup, SModul* smModule);
#endif //_MARKUPHELPERS_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

G. Steudtel

Software Developer (Senior)

Germany

This member has not yet provided a Biography. Assume it's interesting and varied, and probably something to do with programming.

Documenting Header Files

License

Comments and Discussions