writing_icp

...

the contents between which markers will be automatically updated by the documentation builder.

If the file name is foo_bar.cpp, then the Doxygen page reference (from which you can refer to from other pages) will be be foo_bar_icp Foo_bar. Information about the file should be encoded in special block comments of the following format.

/*
#command values...
*/

Supported commands are described below.

• The name of the instance should be given by /* #name Name of Instance */.
• An overview of the algorithm should be provided by /* #desc Overview of algorithm. */. This description will be rendered as Doxygen source, so you can use markdown and Doxygen commands such as \ref.
• If your instance uses icp::ICP::Config parameters, document them as /* #conf "name_of_param" This is a sentence. This is another sentence describing the parameter. */. This description will be rendered as Doxygen source.

• Every major step your instance takes should be documented by

  /*
      #step My Step: brief description
   
      Detailed explanation.
   
      Sources:
      https://www.example.com
      https://www.example.com
      https://www.example.com
      https://www.example.com
  */

  The : brief description section is optional, as are the detailed explanation and sources sections. These descriptions will be rendered as Doxygen source.

See the source code of vanilla.cpp or trimmed.cpp as examples.