HTTPS SSH

z80 doc gen

generates routine documentation from human readable comment blocks

PutS: Routine name
;<SPACE><Txt> Text is a description of the last parent
;<FieldName>:<Comma delmited list of values>
FieldName is a new parent. Denotes stuff
list is values under the Frield
;; continuation of Field Values
line that doesnt start with a ; End the docs

Example

PutS:  
; Puts a string in hl to the screen at the current location  
;INPUT: Pencol/row = Location  
;; HL = Null Term String  
;OutPut: String to Screen  
;Destroys: ALL  
; All Variables are destroy

Enample Text Output

test.asm

PutS
Puts a string in hl to the screen at the current location

INPUT:
 Pencol/row = Location
 HL = Null Term String
 Color in color ram
OutPut:
 String to Screen

Destroys:
 ALL
All variables are destroyed

Example Dict Output

{
   'test.asm':{
      'TodoString':[
      ],
      'Thisisatest':{
         'Description':[
            'Blargeles',
            'thegame'
         ]
      },
      'PutS':{
         'Fields':{
            'INPUT:':{
               'Values':[
                  ' Pencol/row = Location',
                  ' HL = Null Term String'
               ]
            },
            'OutPut:':{
               'Values':[
                  ' String to
 Screen'
               ]
            },
            'Destroys:':{
               'Values':[
                  ' ALL'
               ],
               'Description':[
                  'All variables are destroyed'
               ]
            }
         },
         'Description':[
            'Puts a string in hl to the screen at the current location'
         ]
      }
   }
}