1 / 6

Documentation

Documentation. Oded Magid & Dafi Mor. What is Doxygen ?. Doxygen is a documentation system for C++, C, Java and more . . . Can generate a documentation manual from a set of documented source files. The outcome is a manual for our code

louvain
Download Presentation

Documentation

An Image/Link below is provided (as is) to download presentation Download Policy: Content on the Website is provided to you AS IS for your information and personal use and may not be sold / licensed / shared on other websites without getting consent from its author. Content is provided to you AS IS for your information and personal use only. Download presentation by click this link. While downloading, if for some reason you are not able to download a presentation, the publisher may have deleted the file from their server. During download, if you can't get a presentation, the file might be deleted by the publisher.

E N D

Presentation Transcript

  1. Documentation Oded Magid & Dafi Mor

  2. What is Doxygen ? • Doxygen is a documentation system for C++, C, Java and more . . . • Can generate a documentation manual from a set of documented source files. • The outcome is a manual for our code [can be in different formats : HTML (as a web-page), RTF (MS-Word), PostScript, hyperlinked PDF, and manual/help pages]. • The documentation is extracted directly from the sources, which makes it much easier to keep the documentation consistent with the source code.

  3. Installing Doxygen we’ll download the distribution for Windows • First we download

  4. How does it work ? • The main idea is that we use special comment blocks with some additional markings, so doxygen knows it is a piece of documentation that needs to end up in the generated documentation.

  5. …How does it work ? • There are several ways to mark a comment block as a detailed description: /** * ... text ... */ /*! * ... text ... */ /*! ... text ... */ /// /// ... text ... ///

  6. Special commands • \brief Brief description • \struct to document a C-struct. • \enum to document an enumeration type. • \fn to document a function. • \var to document a variable or typedef or enum value. • \def to document a #define. • \typedef to document a type definition. • \file to document a file. • \namespace to document a namespace. • \package to document a Java package.

More Related