CodeVocabDoxygen

From VoCamp Wiki

Contents 1 Doxygen 2 Class Documentation 3 Function Documentation 4 Attribute Declaration

[edit] Doxygen

Doxygen is a documentation system for C++, C, Java, Objective-C, Python, IDL, Fortran, VHDL, PHP, C#, and D. It generates an on-line documentation browser (in HTML) and/or an off-line reference manual (in LaTeX) from a set of documented source files, or extracts the code structure from undocumented source files.

[edit] Class Documentation

Label(s): "Class"

Also calls related classes "Friend" or "Friend Class"

[edit] Function Documentation

For each class:

Label(s): "Public Member Function" includes "Constructor", "Destructor", "[class name] method", "Initialization method"

For each function, documentation includes "Parameter" and "Returns", if applicable. Note that all functions are also called "members".

[edit] Attribute Declaration

For each class:

Label(s): "Protected Attribute"