Class Commenting for Doxygen

This is how our company comments our header files.

We include our copyright notice on the top of each file with the provided filename.

/******************************************

/ Filename: Foo.h

/ Copyright 2010, Pathfinder Therapeutics, Inc.

/******************************************/

My VA snippet is:

/*****************************************

/ Filename: $FILE_BASE$.$FILE_EXT$

/ Copyright $YEAR$, Pathfinder Therapeutics, Inc.

/*****************************************/

In order for the Doxygen ouput to work, we have to place the class comment immediately before the start of class. Here we include any information a user needs to know to use the class correctly. An example is:

/**

* Generates data to use.

*

* Long description goes here

*

* MAIN PROCEDURE:

* 1. ...

*

* \author Bob

* \date 2010/02/08

* \version 1.0

*/

class Foo

{

...

};

My VA snippet for this is:

/**

* ShortDescr

*

* \author [YOUR NAME HERE]

* \date $DATE$

* \version 1.0

*/