Switch VTK-style documentation to Doxygen or Sphinx.

[vibraphone]

Many classes in SMTK use VTK-style documentation conventions. Since SMTK does not have the perl scripts that VTK uses to convert these comments into Doxygen format, they are not being included in the generated reference documentation.

[BobObara]

Guess the question is - what would a Doxygen vs Sphinx documentation look like? Both in terms of the in code format and the generated docs?

Bob

Robert M. O'Bara, MEng.
Assistant Director of Scientific Computing

Kitware Inc.
28 Corporate Drive
Suite 101
Clifton Park, NY 12065

Phone: (518) 881- 4931

On Feb 5, 2015, at 4:46 PM, David Thompson [email protected] wrote:

Many classes in SMTK use VTK-style documentation conventions. Since SMTK does not have the perl scripts that VTK uses to convert these comments into Doxygen format, they are not being included in the generated reference documentation.

—
Reply to this email directly or view it on GitHub #51.

[vibraphone]

The generated docs (where switching to doxygen) would look exactly like VTK's generated docs because that's what VTK uses. The code format would switch from this at the top of the header

// .NAME smtkAttribute.h - Represents a standalone piece of simulation information
// .SECTION Description
// .SECTION See Also

and this before methods in the header

// Description:
// Blah.
int blah();

to this just above the class declaration:

/**\brief Represents a standalone piece of simulation information
  *
  * \sa
  */

and this just above each method implementation (i.e., not in the header):

/**\brief Blah.
  */
int blah()
{ // ...