namespace mom_document

Overview

The subroutines here provide hooks for document generation functions at various levels of granularity. More…

namespace mom_document {

// interfaces

interface doc_param;

// global functions

subroutine, public doc_openblock(doc doc, blockName blockName, desc desc);
subroutine, public doc_closeblock(doc doc, blockName blockName);
subroutine, public doc_module(doc doc, modname modname, desc desc);
subroutine, public doc_subroutine(doc doc, modname modname, subname subname, desc desc);
subroutine, public doc_function(doc doc, modname modname, fnname fnname, desc desc);

subroutine, public doc_init(
    docFileBase docFileBase,
    doc doc,
    minimal minimal,
    complete complete,
    layout layout,
    debugging debugging
    );

subroutine, public doc_end(doc doc);

} // namespace mom_document

Detailed Documentation

The subroutines here provide hooks for document generation functions at various levels of granularity.

Global Functions

subroutine, public doc_openblock(doc doc, blockName blockName, desc desc)

This subroutine handles documentation for opening a parameter block.

Parameters:

doc	A pointer to a structure that controls where the documentation occurs and its formatting
blockname	The name of the parameter block being opened
desc	A description of the parameter block being opened

subroutine, public doc_closeblock(doc doc, blockName blockName)

This subroutine handles documentation for closing a parameter block.

Parameters:

doc	A pointer to a structure that controls where the documentation occurs and its formatting
blockname	The name of the parameter block being closed

subroutine, public doc_module(doc doc, modname modname, desc desc)

This subroutine handles the module documentation.

Parameters:

doc	A pointer to a structure that controls where the documentation occurs and its formatting
modname	The name of the module being documented
desc	A description of the module being documented

subroutine, public doc_subroutine(
    doc doc,
    modname modname,
    subname subname,
    desc desc
    )

This subroutine handles the subroutine documentation.

Parameters:

doc	A pointer to a structure that controls where the documentation occurs and its formatting
modname	The name of the module being documented
subname	The name of the subroutine being documented
desc	A description of the subroutine being documented

subroutine, public doc_function(
    doc doc,
    modname modname,
    fnname fnname,
    desc desc
    )

This subroutine handles the function documentation.

Parameters:

doc	A pointer to a structure that controls where the documentation occurs and its formatting
modname	The name of the module being documented
fnname	The name of the function being documented
desc	A description of the function being documented

subroutine, public doc_init(
    docFileBase docFileBase,
    doc doc,
    minimal minimal,
    complete complete,
    layout layout,
    debugging debugging
    )

Initialize the parameter documentation.

Parameters:

docfilebase	The base file name for this set of parameters, for example MOM_parameter_doc
doc	A pointer to a structure that controls where the documentation occurs and its formatting
minimal	If present and true, write out the files (.short) documenting those parameters that do not take on their default values.
complete	If present and true, write out the (.all) files documenting all parameters
layout	If present and true, write out the (.layout) files documenting the layout parameters
debugging	If present and true, write out the (.debugging) files documenting the debugging parameters

subroutine, public doc_end(doc doc)

This subroutine closes the the files controlled by doc, and sets flags in doc to indicate that parameterization is no longer permitted.

Parameters:

doc	A pointer to a structure that controls where the documentation occurs and its formatting