CMSSW Documentation

This is the CMSSW Reference Manual, the reference documentation of all classes and packages in CMSSW.

This page explains how to write the documentation for your code.

Class Documentation

Classes and methods are documented with properly formatted comments in the code.

Here is a template of a documented .h file, and of a .cc file. The resulting doxygen page is here.

Package Documentation

Each package should contain a very brief description of its content and purpose. Remember that this is a reference, and not a user's guide: tutorials, howtos, etc. are best documented in the CMS Offline Guide and in the WorkBook. Cross links between the CMS Offline Guide and the WorkBook and this manual are a good way to avoid duplication of content.

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.

How to generate your documentation locally

One you have updated your documentation, you can look at how it displays in the following way:

• check out the following packages:

   > cmsrel CMSSW_7_X_X
       > cd CMSSW_7_X_X/
       > cmsenv
       > git cms-addpkg Documentation
  
       > generate_reference_manual
  
       wait...
  
       > firefox doc/html/index.html