Better Doxygen comments for CMFD initialization methods in the Geometry class

[wbinventor]

The Doxygen comments for the CMFD methods in the Geometry class describe what the methods do, but do not indicate whether or not these methods are intended to be called by the user from Python, or are used internally by the C/C++ source code. The methods I've noticed are the following:

1) Geometry::initializeMesh(...) 2) Geometry::defineMesh(...) 3) Geometry::nextLatticeHeight(...) 4) Geometry::findMeshHeight(...) 5) Geometry::findMeshWidth(...) 6) Geometry::findMeshDepth(...)

If they are used internally as helper methods, it would be best to make the methods private rather than public if possible. If this is not possible, the comments should include something like the following in order to conform to other code comments in OpenMOC:

• @details NOTE: This method is not intended to be called by the user from Python and is * reserved for internal use by OpenMOC only.

Alternatively, if the methods are intended to be called by the user from Python, add a descriptive code element to the Doxygen code block which gives an example of how to use the method as so:

• @brief ...
• @details This method may be called by the user from Python as follows: *
• @code
• universe = geometry.getUniverse(0)
• height = geometry.nextLatticeHeight(univ)
• @endcode *
• @param ...
• @return ...

Regardless of whether they are internally used or exposed for the user to use, explain what they are used for and which routine(s) call them.

[wbinventor]

@samuelshaner - is this issue relevant anymore with all of the changes you made for v0.1.3?

[samuelshaner]

I updated the documentation, so I think we can close it.