[<<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......: PRTSCR.C
* Author....: Ted Means
* CIS ID....: 73067,3332
*
* This is an original work by Ted Means and is placed in the
* public domain.
*
* Modification history:
* ---------------------
*
*/
/* $DOC$
* $FUNCNAME$
* FT_PrtScr()
* $ONELINER$
* Enable or disable printscreens
* $SYNTAX$
* FT_PrtScr( <lSetStat> ) -> lCurStat
* $ARGUMENTS$
* <lSetStat> set to .T. will enable printscreens, .F. will
* disable printscreens.
* $RETURNS$
* The current state ( .T. for enabled, .F. for disabled).
* $DESCRIPTION$
* This function is valuable if you have a need to disable the
* printscreen key. It works by fooling the BIOS into thinking
* that a printscreen is already in progress. The BIOS will then
* refuse to invoke the printscreen handler.
* $EXAMPLES$
* FT_PrtScr( .F. ) // Disable the printscreen key
* FT_PrtScr( .T. ) // Enable the printscreen key
* MemVar := FT_PrtScr() // Get the current status
* $INCLUDE$
* FTVIDEO.CH
* $SEEALSO$
* ft_peek() ft_poke()
* $END$
*/
Formatting Guidelines
/*
* File......: PRTSCR.C
* Author....: Ted Means
* CIS ID....: 73067,3332
*
* This is an original work by Ted Means and is placed in the
* public domain.
*
* Modification history:
* ---------------------
*/
/* $DOC$
* $FUNCNAME$
+--------------- indent all items 6 spaces after asterisk
* + FT_PRTSCR() <- 15 characters MAXIMUM
* |$ONELINER$
* | Enable or disable printscreens <- 60 character MAXIMUM
* |$SYNTAX$
* | FT_PRTSCR( <lSetStat> ) -> lCurStat
* |$ARGUMENTS$ +------------------- Parameters in angle brackets
* | <lSetStat> set to .T. will enable printscreens, .F. will
* | disable printscreens.
* |$RETURNS$
* | The current state ( .T. for enabled, .F. for disabled).
* |$DESCRIPTION$
* | This function is valuable if you have a need to disable the
* | printscreen key. It works by fooling the BIOS into thinking
* | that a printscreen is already in progress. The BIOS will then
* | refuse to invoke the printscreen handler.
| +------------- Lines no longer than 65 characters --------------+
* |$EXAMPLES$
* | FT_PRTSCR( .F. ) // Disable the printscreen key
* | FT_PRTSCR( .T. ) // Enable the printscreen key
* | MemVar := FT_PRTSCR() // Get the current status
* |$INCLUDE$
* | FTVIDEO.CH <- optional
* |$SEEALSO$
* | FT_PEEK() FT_POKE() <- optional
* |$END$
*/|
+- Function names in all caps
See Also:
Sample ASM header
Submitting code for the Library
This page created by ng2html v1.05, the Norton guide to HTML conversion utility.
Written by Dave Pearson