Information About

Doxygen





Information

  name Doxygen
  developer Dimitri Van Heesch
  latest Release Version 153
  latest Release Date 27 July , 2007
  operating System GNU/Linux , Windows , Mac OS , Solaris
  genre Documentation Generator
  license GNU General Public License
  website Doxygen


Doxygen is a Documentation Generator for C++ , C , Java , Objective-C , Python , IDL ( Corba and Microsoft flavors) and to some extent PHP , C# , D and ActionScript . It runs on most Unix-like systems as well as on Windows and Mac OS X . Most of the Doxygen code was written by Dimitri Van Heesch .

KDE uses Doxygen for parts of its documentation and KDevelop has built-in support for it.


USAGE

Like Javadoc , Doxygen extracts documentation from source file comments. In addition to the Javadoc syntax it supports the documentation tags used in the Qt Toolkit and can generate output in HTML as well as in CHM , RTF , PDF , LaTeX , PostScript or Man Pages .


EXAMPLE CODE

The following illustrates how a source file can be documented.

  • ---

  • The time class represents a moment of time.


  • ''\author'' John Doe

  • /

  • class Time {


  • ---

  • Constructor that sets the time to a given value.

  • ''\param'' timemillis is a number of milliseconds passed since Jan 1. 1970

  • /

  • Time(int timemillis) {

...
}

  • ---

  • Get the current time.

  • '' eturn'' A time object set to the current time.

  • /

  • static Time now() {

...
}
};


SEE ALSO




EXTERNAL LINKS