Domain | Contact |
---|
Learn how to build Reference Manual
This page explains how to write the documentation for your code.
Here is a template of a documented .h file, and of a .cc file. The resulting doxygen page is here.
This documentation should be written in a file [Package]/doc/[Package].doc. The simplest way of doing this is to go to the doc/ directory in your package and then run the script makePackageDoc, which is available in your PATH.
> cmsrel CMSSW_7_X_X > cd CMSSW_7_X_X/ > cmsenv > git cms-addpkg Documentation > generate_reference_manual wait... > firefox doc/html/index.html
Learn more about special doxygen commands