****************************************************************************
*
*         SOURCE DOCUMENTATION SYNTAX USED FOR MADMAC MACRO ASSEMBLER
*
*---------------------------------------------------------------------------
*
*  Edition  :  1
*  Author   :  Harald Siegmund
*
*---------------------------------------------------------------------------
*
*  History  :
*
*  1991:
*     Dec 29: creation of file (as excerpt from NKCC.S)
*
****************************************************************************

****************************************************************************
* General information:
****************************************************************************
*
*  shortcuts:
*     ^     adr      pointer/address of
*     #     num      number
*     ~^    off      offset
*           ref      reference
*           tmp      temporary
*           calc     calculate
*     <xxx>          label/variable/parameter
*     xx...          list
*
*  object sizes:
*     .b             signed byte
*     .B             unsigned byte
*     .w             signed word
*     .W             unsigned word
*     .h             signed register high word
*     .H             unsigned register high word
*     .l             signed long
*     .L             unsigned long
*     .x             any signed size
*     .X             any unsigned siize
*     .-             anything
*     []             array (additional)
*
*  object locations:
*     D0...7         CPU registers
*     A0...6
*     SP, USP, SSP
*     CCR, SR
*     label:         memory location
*     label()        function
*     B:function()   bios function
*     X:function()   xbios function
*     G:function()   gemdos function
*     A:function()   AES function
*     V:function()   VDI function
*     S:variable     system variable
*     H:variable     hardware location
*
*  object access types:
*     R              read only
*     W              write only
*     U              update (read & write)
*     X              execute (may be combined with R/W/U)
*     ^...           indirect access (e.g. ^R), implies direct read access
*     .              untouched
*     *              corrupted/undefined
*
*  source sections:
*     ASSEMBLER CONTROL SECTION     includes/assemly influencing equates
*     IMPORT                        imported symbols
*     EXPORT                        exported symbols
*     EQUATES                       symbol equates
*     ABSOLUTE SECTION              structure definitions
*     MACROS                        macro definitions
*     LOCAL TEXT SECTION            text (local functions)
*     GLOBAL TEXT SECTION           text (global, will be exported)
*     LOCAL DATA SECTION            initialized data (local)
*     GLOBAL DATA SECTION           initialized data (global, exported)
*     LOCAL BSS SECTION             block storage (local)
*     GLOBAL BSS SECTION            block storage (global, exported)
*
*  text formatting:
*      3             tab width
*     15             opcode field
*     24             operand field
*     45             comment field
*     all characters except NUL may appear in the source!
*     * ;            comment characters (* only in first row)
*
*  miscellaneous:
*     all directives begin with .
*     *START and *END (used for Make Control) mark module header, includes,
*      imports and exports of all type, global function headers and special
*      code
*
*  function header:
*     A              access type
*    info:
*     I#             interrupt level #
*     T#             trap handler
*     G              global
*     R              reentrant
*     S              supervisor state requested
*     U              user state requested
****************************************************************************

****************************************************************************
* Function header:
****************************************************************************
*
*  funcname: short description
*  # info
*
*  long description (several lines)
*
*  In:   A  location.s     description             formal input
*  Out:  A  location.s     description             formal output
*
*  Reg:  D:01234567   A:01234567   CCR
*          AAAAAAAA     AAAAAAAA    A
*
****************************************************************************
*END

*EOF