mom_document::doc_param subroutine subroutine mom_document::doc_param::doc_param_none (doc, varname, desc, units) doc_param_none doc doc varname varname desc desc units units This subroutine handles parameter documentation with no value. doc A pointer to a structure that controls where the documentation occurs and its formatting varname The name of the parameter being documented desc A description of the parameter being documented units The units of the parameter being documented subroutine subroutine mom_document::doc_param::doc_param_logical (doc, varname, desc, units, val, default, layoutParam, debuggingParam, like_default) doc_param_logical doc doc varname varname desc desc units units val val default default layoutParam layoutParam debuggingParam debuggingParam like_default like_default This subroutine handles parameter documentation for logicals. doc A pointer to a structure that controls where the documentation occurs and its formatting varname The name of the parameter being documented desc A description of the parameter being documented units The units of the parameter being documented val The value of this parameter default The default value of this parameter layoutparam If present and true, this is a layout parameter. debuggingparam If present and true, this is a debugging parameter. like_default If present and true, log this parameter as though it has the default value, even if there is no default. subroutine subroutine mom_document::doc_param::doc_param_logical_array (doc, varname, desc, units, vals, default, layoutParam, debuggingParam, like_default) doc_param_logical_array doc doc varname varname desc desc units units vals vals default default layoutParam layoutParam debuggingParam debuggingParam like_default like_default This subroutine handles parameter documentation for arrays of logicals. doc A pointer to a structure that controls where the documentation occurs and its formatting varname The name of the parameter being documented desc A description of the parameter being documented units The units of the parameter being documented vals The array of values to record default The default value of this parameter layoutparam If present and true, this is a layout parameter. debuggingparam If present and true, this is a debugging parameter. like_default If present and true, log this parameter as though it has the default value, even if there is no default. subroutine subroutine mom_document::doc_param::doc_param_int (doc, varname, desc, units, val, default, layoutParam, debuggingParam, like_default) doc_param_int doc doc varname varname desc desc units units val val default default layoutParam layoutParam debuggingParam debuggingParam like_default like_default This subroutine handles parameter documentation for integers. doc A pointer to a structure that controls where the documentation occurs and its formatting varname The name of the parameter being documented desc A description of the parameter being documented units The units of the parameter being documented val The value of this parameter default The default value of this parameter layoutparam If present and true, this is a layout parameter. debuggingparam If present and true, this is a debugging parameter. like_default If present and true, log this parameter as though it has the default value, even if there is no default. subroutine subroutine mom_document::doc_param::doc_param_int_array (doc, varname, desc, units, vals, default, layoutParam, debuggingParam, like_default) doc_param_int_array doc doc varname varname desc desc units units vals vals default default layoutParam layoutParam debuggingParam debuggingParam like_default like_default This subroutine handles parameter documentation for arrays of integers. doc A pointer to a structure that controls where the documentation occurs and its formatting varname The name of the parameter being documented desc A description of the parameter being documented units The units of the parameter being documented vals The array of values to record default The default value of this parameter layoutparam If present and true, this is a layout parameter. debuggingparam If present and true, this is a debugging parameter. like_default If present and true, log this parameter as though it has the default value, even if there is no default. subroutine subroutine mom_document::doc_param::doc_param_real (doc, varname, desc, units, val, default, debuggingParam, like_default) doc_param_real doc doc varname varname desc desc units units val val default default debuggingParam debuggingParam like_default like_default This subroutine handles parameter documentation for reals. doc A pointer to a structure that controls where the documentation occurs and its formatting varname The name of the parameter being documented desc A description of the parameter being documented units The units of the parameter being documented val The value of this parameter default The default value of this parameter debuggingparam If present and true, this is a debugging parameter. like_default If present and true, log this parameter as though it has the default value, even if there is no default. subroutine subroutine mom_document::doc_param::doc_param_real_array (doc, varname, desc, units, vals, default, debuggingParam, like_default) doc_param_real_array doc doc varname varname desc desc units units vals vals default default debuggingParam debuggingParam like_default like_default This subroutine handles parameter documentation for arrays of reals. doc A pointer to a structure that controls where the documentation occurs and its formatting varname The name of the parameter being documented desc A description of the parameter being documented units The units of the parameter being documented vals The array of values to record default The default value of this parameter debuggingparam If present and true, this is a debugging parameter. like_default If present and true, log this parameter as though it has the default value, even if there is no default. subroutine subroutine mom_document::doc_param::doc_param_char (doc, varname, desc, units, val, default, layoutParam, debuggingParam, like_default) doc_param_char doc doc varname varname desc desc units units val val default default layoutParam layoutParam debuggingParam debuggingParam like_default like_default This subroutine handles parameter documentation for character strings. doc A pointer to a structure that controls where the documentation occurs and its formatting varname The name of the parameter being documented desc A description of the parameter being documented units The units of the parameter being documented val The value of the parameter default The default value of this parameter layoutparam If present and true, this is a layout parameter. debuggingparam If present and true, this is a debugging parameter. like_default If present and true, log this parameter as though it has the default value, even if there is no default. subroutine subroutine mom_document::doc_param::doc_param_time (doc, varname, desc, val, default, units, debuggingParam, like_default) doc_param_time doc doc varname varname desc desc val val default default units units debuggingParam debuggingParam like_default like_default This subroutine handles parameter documentation for time-type variables. doc A pointer to a structure that controls where the documentation occurs and its formatting varname The name of the parameter being documented desc A description of the parameter being documented val The value of the parameter default The default value of this parameter units The units of the parameter being documented debuggingparam If present and true, this is a debugging parameter. like_default If present and true, log this parameter as though it has the default value, even if there is no default. Document parameter values. mom_document::doc_paramdoc_param_char mom_document::doc_paramdoc_param_int mom_document::doc_paramdoc_param_int_array mom_document::doc_paramdoc_param_logical mom_document::doc_paramdoc_param_logical_array mom_document::doc_paramdoc_param_none mom_document::doc_paramdoc_param_real mom_document::doc_paramdoc_param_real_array mom_document::doc_paramdoc_param_time