Home | Download/Install | Documentation | Packages | Screenshots | News | Forum/Mailing-lists | Contact | GForge

How to document C++ API

Introduction

Packages can be based on compiled library. We discuss in this document documentation tools to create C++ API.

Doxygen

Doxygen is a documentation generator for C++, C, Java, etc. It can generate an on-line documentation browser (in HTML) and/or an off-line reference manual (in latex) from a set of documented source files. You can also visualize the relations between the various elements by means of include dependency graphs, inheritance diagrams, and collaboration diagrams, which are all generated automatically.

http://www.doxygen.org/

/**
 * 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.
   * \return A time object set to the current time.
   */
  static Time now() {
    ...
  }
};
 
documentation/doctests/how_to_document_cpp_api.txt · Last modified: 2007/05/03 17:29 (external edit)   Back to top
INRIA   INRA     CIRAD     AGROPOLIS
INRIA GForge RSS feed Valid XHTML 1.0 Valid CSS Driven by DokuWiki