L24documentation

L24documentation - Doxygen Comment Format ● Doxygen...

Info iconThis preview shows pages 1–5. Sign up to view the full content.

View Full Document Right Arrow Icon
Automatic Documentation Systems
Background image of page 1

Info iconThis preview has intentionally blurred sections. Sign up to view the full version.

View Full DocumentRight Arrow Icon
Why Automatic Documentation derives documentation directly from the code simplifies maintenance of code documentation produces high quality up-to-date documentation that makes understanding the code easier doxygen is one of often-used documentation generation systems
Background image of page 2
Setting Up and Runnign Doxygen doxygen is a free automatic documentation generation system generates code for all files in a specific directories (including subdirectories) before running needs a configuration file can generate template as follows doxygen –g default configuration file is stored in Doxyfile most default settings are satisfactory disable LaTeX documentation generation if configuration file is set up, to run doxygen type doxygen [directory name] by default – current directory is used creates subdirectory html with HTML-formatted documentation when running watch output for warnings and uncommented constructs
Background image of page 3

Info iconThis preview has intentionally blurred sections. Sign up to view the full version.

View Full DocumentRight Arrow Icon
Background image of page 4
Background image of page 5
This is the end of the preview. Sign up to access the rest of the document.

Unformatted text preview: Doxygen Comment Format ● Doxygen examines C++ comments and uses them to document the code ● to be considered by Doxygen the comments have to be formatted in a certain way ● two types of descriptions ■ brief – a one line short description of the construct, multiple variants of formatting, three slashes work /// example brief description ■ long – detailed description, tends to be multiple-lines long use c-style comments, note the extra star /** this is an example * of a long description * / ● there can be at most one long and one short description ● description either immediately precedes or follows the construct Documented Constructs ● by default Doxygen examines header files and documents classes and functions it finds there ● to document constructs in other files (.cpp) put a Doxygen comment in the beginning with a word \file in it ■ note that \file should be the last on the comment line...
View Full Document

This note was uploaded on 04/22/2010 for the course CS 23021 taught by Professor Staff during the Spring '08 term at Kent State.

Page1 / 5

L24documentation - Doxygen Comment Format ● Doxygen...

This preview shows document pages 1 - 5. Sign up to view the full document.

View Full Document Right Arrow Icon
Ask a homework question - tutors are online