AJClock AJPopup Icon CommandLine Favourites Window FixWAV FunctionPtrs Q2 mini-mod Indexer Map Studio mIRCplugin SourceParser Time Monitor TVTicker webplugin Whistler

Source Parser

Summary Documenting C++ code is not an easy task, but fully documented code can be extremely useful - being able to turn to a document and look up the classes and read about how they are put together can be extremely useful.

There are two main ways of maintaining documentation - one to do it manually in an external document, or the other to embed the whole documentation inside the source code and to automatically extract it. I dont like either alternative - the documentation doesnt belong in the code as it could get big, and should have the ability to include images etc.

To resolve this, I have written this program that automatically creates a document based upon the code, but will get descriptions of the classes from a database - or thats the idea anyway, at the moment, the parser is written and pulls out accurate prototypes of the classses and all of their members, but the database persistance is not yet maintained.

Download and Installation Sorry, not available for download at this time.

Options
Screenshot

Current build of source parser simply allows selection of where to load the source code from, and an option to clear the content.

The parser will extract multiple classes per file, and will search all .h and .hpp files in the given directory. The parser pulls out the following details for member functions of classes:

  • Return type
  • Member name
  • List of arguments (type and name separated out)
  • Whether the member function is inlined
  • Whether the member function is const
  • Whether the member function is virtual
  • Whether the member function is static