next up previous contents
Next: A.4.3 Template for a Up: A.4 ProTex Templates Previous: A.4.1 Template for routines

A.4.2 Template for a routine internal to a module

Module-internal routines can be either functions or subroutines defined inside of a module, i.e., after the F90 CONTAINS keyword. The difference to the ROUTINE documentation is only minor. The internal routine documentation will become the subsection of the module's LaTeXsection, thus saving the conceptual hierarchy.

!
! Use !IROUTINE for subroutines/functions that come after a CONTAINS
! statement, i.e., routines internal to a Module or subroutine.
!

!-------------------------------------------------------------------------
!         NASA/GSFC, Data Assimilation Office, Code 910.3, GEOS/DAS      !
!-------------------------------------------------------------------------
!BOP
!
! !IROUTINE:  
! 
! !INTERFACE:
!
! !INPUT PARAMETERS: 
!
! !INPUT/OUTPUT PARAMETERS: 
!
! !OUTPUT PARAMETERS:
!
! !DESCRIPTION: 
!
! !REVISION HISTORY: 
!
!  27Jun97   Jim Becile  Initial code.
!
!EOP
!-------------------------------------------------------------------------
!BOC
!EOC

It is appropriate to add the !BOC and !EOC markers to indicate the code section, however this is not obligatory.



Will Sawyer
Fri Mar 6 18:02:18 EST 1998