Skip to content

Documentation

Jump to bottom
Cisco edited this page Oct 16, 2025 · 4 revisions
  • The documentation relies on a few Doxygen keywords
  • Simple functions (getter, setter...) do not require documentation
  • Every other function should include at least
    • @brief
    • @return if is not void
    • @param for each param, with details about requirements or expected format
    • @throw when throws an Exception
  • and possibly
    • @remark, @warning
    • @class, @struct, @enum -
    • @details
    • @param[out] if it is a pointer or reference being used as a return value
    • @example
    • @if, @ifnot, @else, @elseif, @endif

Page organization

  • grouping
  • member groups (ie grouping docs for getters/setters)
  • subpaging

Doxygen installation on Ubuntu

  • install dependencies
# flex lexical analyzer
wget https://github.com/westes/flex/files/981163/flex-2.6.4.tar.gz
tar -xzf flex-2.6.4.tar.gz
cd flex-2.6.4
./configure --prefix=$HOME/.local
make
make install
cd ..

# bison (GNU parser generator)
wget http://ftp.gnu.org/gnu/bison/bison-3.8.2.tar.gz
tar -xzf bison-3.8.2.tar.gz
cd bison-3.8.2
./configure --prefix=$HOME/.local
make
make install
cd..

# libiconv
wget https://ftp.gnu.org/pub/gnu/libiconv/libiconv-1.18.tar.gz
tar -xzf libiconv-1.18.tar.gz
cd libiconv-1.18
./configure --prefix=$HOME/.local
make
make install
cd..

# add /usr/local/bin to PATH and LD_LIBRARY_PATH if not
export LD_LIBRARY_PATH=$HOME/.local/lib:$LD_LIBRARY_PATH

# test install
source ~/.bashrc
which flex bison libiconv

https://www.doxygen.nl/manual/install.html#install_bin_unix

Source

https://www.doxygen.nl/manual/commands.html https://www.doxygen.nl/manual/grouping.html https://docs.rosettacommons.org/docs/latest/development_documentation/tutorials/doxygen-tips

Clone this wiki locally