Doxygen Example

This file is an example of documentation that is generated by Doxygen.

You can find the Doxygen info here.

You can find the license info here.

I made a logo from wix.com:

Looks awesome right?

Also, see here to enter github pages.

Contents

1. Introduction
2. Doxygen Note
3. To-do List

Doxygen Note

Installation

Ubuntu 20.04

For Ubuntu 20.04, before installing the Doxygen, some other packages/libraries should be installed first. The following list can be helpful:

1. CMake: one can directly download the binary .sh file from CMake Download, and run something like: /bin/sh cmake-3.22.1-linux-x86_64.sh.
2. GNU flex: simply run: sudo apt-get update and sudo apt-get install flex.
3. GNU bison: sudo apt-get update and sudo apt-get install binson.
4. libiconv: follow the guide here: Installing libiconv on Ubuntu Linux

After all that, you can install the Doxygen from source:

git clone https://github.com/doxygen/doxygen.git
cd doxygen

mkdir build
cd build
cmake -G "Unix Makefiles" ..
make

sudo make install

Comment Blocks

1. You can use either

   /** Line 1
    *  Line 2
    *  Line 3
    */
   Constructor()
   

   or

   Constructor() /**< Line 1
   	       *   Line 2
   	       *   Line 3
   	       */
   

back to top

Special Comannds

1. To jump to a function or parameter, you can use @see FOO to point it out.

2. To display a parameter and describe its usage, you can use @param FOO The example parameter.

3. To start a new line, one could use <br> or \n.

back to top

To-do List

• Make table of contents.
• Add more comments in this example.

back to top