Thread: Automatic Code API Documentation Software

  1. #1
    Registered User
    Join Date
    Jun 2008

    Automatic Code API Documentation Software

    Hello All,

    I have been designing some code libraries for an embedded system that I plan to release soon as an Open-Source software solution for an AVR development board. After finishing the code development (which will probably continue on and on as I add more features), I wanted to start working on documenting the code in some kind of simple help file format that can be sent out with the source code for reference. However, I don't want to have to manually create and maintain the documentation since the code will constantly be updated with new features and so on.

    So I started doing some googling around to see what is out there in the way of automatic documentation generators. I have read about quite a few different options but I wanted to know if anyone here has had any experience with such software and if anyone may have any recommendations. Ideally, I was looking to make something that could be compiled into a standard HTML help file with links to different functions and so on. What do you all think?

    Jason O

  2. #2
    Woof, woof! zacs7's Avatar
    Join Date
    Mar 2007
    Certainly, try doxygen.

    And documenting the code after you've written it is very poor, in any fashion.

  3. #3
    Registered User
    Join Date
    Jun 2008
    Yes I agree. it is always better to do the planning prior to any coding. However, this was a unique case where the resulting application was composed of a hodge-podge of existing code from other odd and end projects. Thanks for the tip.

  4. #4
    Registered User jeffcobb's Avatar
    Join Date
    Dec 2009
    Henderson, NV
    I second Doxygen. It won't do the whole job "automagically" but it will meet you half-way and turn out pretty decent docs. Basically you have to add file, class, variable and function comments in a certain way and then Doxygen uses that to write docs. That said, it you are on a Linux box, Umbrello can suck in C/C++ source and gen UML diagrams and class relationships of different types...and its free.
    C/C++ Environment: GNU CC/Emacs
    Make system: CMake
    Debuggers: Valgrind/GDB

Popular pages Recent additions subscribe to a feed

Similar Threads

  1. Memory Leak in AppWizard-Generated Code
    By jrohde in forum Windows Programming
    Replies: 4
    Last Post: 05-19-2010, 04:24 PM
  2. Enforcing Machine Code Restrictions?
    By SMurf in forum Tech Board
    Replies: 21
    Last Post: 03-30-2009, 07:34 AM
  3. How to write source code documentation?
    By loobian in forum C++ Programming
    Replies: 2
    Last Post: 06-07-2005, 11:49 AM
  4. X11 api documentation?
    By EvBladeRunnervE in forum Linux Programming
    Replies: 6
    Last Post: 09-12-2003, 07:17 AM
  5. Replies: 4
    Last Post: 01-15-2002, 11:04 PM
Website Security Test