[<<Previous Entry] [^^Up^^] [Next Entry>>] [Menu] [About The Guide]
This example shows how you would set up the
headers for either a Clipper or C source file.
/*
* File......: PRINSCRN.PRG
* Author....: Martin Colloby
* BBS.......: The Dark Knight Returns
* Net/Node..: 050/069
* User Name.: Martin Colloby
* Date......: 18/4/93
* Revision..: 1.0
*
* This is an original work by Martin Colloby and is placed in the public
* domain.
*
* Modification history:
* ---------------------
*
* $Log$
*
*/
/* $DOC$
* $FUNCNAME$
* GT_PrintScreen
* $CATEGORY$
* Video
* $ONELINER$
* Output a screen to the printer
* $SYNTAX$
* GT_PrintScreen( cScreen )
* $ARGUMENTS$
* cScreen - Screen saved by FT_SAVRGN()
* $RETURNS$
* NIL
* $DESCRIPTION$
* Outputs a screen to the printer. The screen should be saved using
* the Nanforum Toolkit function FT_SAVRGN, and then passed to this
* function
* $EXAMPLES$
* GT_PrintScreen( FT_SAVRGN( 0 , 0 , MAXROW() , MAXCOL() )
* $SEEALSO$
*
* $INCLUDE$
*
* $END$
*/
Formatting Guidelines
/*
* File......: PRINSCRN.PRG
* Author....: Martin Colloby
* BBS.......: The Dark Knight Returns
* Net/Node..: 050/069
* User Name.: Martin Colloby
* Date......: 18/4/93
* Revision..: 1.0
*
* This is an original work by Martin Colloby and is placed in the public
* domain.
+------------- This declaration must be present ---------------------+
*
* Modification history:
* ---------------------
*
* $Log$
*
*/
/* $DOC$
* $FUNCNAME$
+--------------- indent all items 6 spaces after asterisk
* GT_PrintScreen <- 15 characters MAXIMUM
* $CATEGORY$
* Video <- Put 'General' if not sure
* $ONELINER$
* Output a screen to the printer <- 60 character MAXIMUM
* $SYNTAX$
* GT_PrintScreen( cScreen )
* $ARGUMENTS$
* cScreen - Screen saved by FT_SAVRGN()
* $RETURNS$
* NIL
* $DESCRIPTION$
* Outputs a screen to the printer. The screen should be saved via
* the Nanforum Toolkit function FT_SAVRGN, and then passed to this
* function
+------------- Lines no longer than 65 characters --------------+
* $EXAMPLES$
* GT_PrintScreen( FT_SAVRGN( 0 , 0 , MAXROW() , MAXCOL() )
* $SEEALSO$
* <- optional
* $INCLUDE$
* <- optional
* $END$
*/
Online resources provided by: http://www.ClipX.Net --- NG 2 HTML conversion by Dave Pearson