Detailed Description

A structure that controls where the documentation occurs, its veborsity and formatting.

Definition at line 28 of file MOM_document.F90.

Collaboration diagram for mom_document::doc_type:

Public variables and constants
integer	unitall = -1
	The open unit number for docFileBase + .all.

integer	unitshort = -1
	The open unit number for docFileBase + .short.

integer	unitlayout = -1
	The open unit number for docFileBase + .layout.

integer	unitdebugging = -1
	The open unit number for docFileBase + .debugging.

logical	filesareopen = .false.
	True if any files were successfully opened.

character(len=mlen)	docfilebase = ''
	The basename of the files where run-time parameters, settings and defaults are documented.

logical	complete = .true.
	If true, document all parameters.

logical	minimal = .true.
	If true, document non-default parameters.

logical	layout = .true.
	If true, document layout parameters.

logical	debugging = .true.
	If true, document debugging parameters.

logical	definesyntax = .false.
	If true, use '#def' syntax instead of a=b syntax.

logical	warnonconflicts = .false.
	Cause a WARNING error if defaults differ.

integer	commentcolumn = 32
	Number of spaces before the comment marker.

integer	max_line_len = 112
	The maximum length of message lines.

type(link_msg), pointer	chain_msg => NULL()
	Database of messages.

character(len=240)	blockprefix = ''
	The full name of the current block.

The documentation for this type was generated from the following file:

/home/docs/checkouts/readthedocs.org/user_builds/mom6-doctesting/checkouts/brokenbreathe/src/framework/MOM_document.F90

Public variables and constants