At the start of each piece of code
/** * file * * Every file needs to start with this; brief * * Long * * author Me * * ingroup Imageproc */
Before each subroutine/class
/** * Single line description with no period * * Note: Long description * * eturn This describes the return value if there is one * hrow Any exceptions thrown must be described here * hrow Here too * ingroup I guess imageproc for me */
In the .cc code
template <PixelT, MaskT, KernelT>
static void computePSFMatchingKernelForPostageStamp(
MaskedImage<PixelT, MaskT> const &convolveImage, ///< Goes with the code
MaskedImage<PixelT, MaskT> const &nonconvolveImage, ///< This is for doxygen
LinearCombinationKernel<KernelT> &kernelSet, ///< This is for doxygen
std::vector<KernelT> &kernelCoeffs) { ///< This is for doxygen
Shared pointers are referred to as PtrT in the code.
