Uniforming code and documentation

Author: intoinside

lib/common.asm

@@ -6,12 +6,12 @@
 .filenamespace c128lib
 
 /*
- BasicUpstart for C128
+  BasicUpstart for C128, creates a basic program that sys' the address
 
- Syntax:    BasicUpstart(address)
- Usage example: BasicUpstart($2000)
-             Creates a basic program that sys' the address
- */
+  Syntax:         BasicUpstart128(address)
+  Usage example:  BasicUpstart128($2000)
+
+*/
 .macro BasicUpstart128(address) {
     .pc = $1c01 "C128 Basic"
     .word upstartEnd  // link address
@@ -25,11 +25,11 @@ upstartEnd:
 }
 
 /*
- * Why Kickassembler does not support bitwise negation on numerical values?
- *
- * Params:
- * value: byte to be negated
- */
+  Why Kickassembler does not support bitwise negation on numerical values?
+
+  Params:
+  value: byte to be negated
+*/
 .function neg(value) {
   .return value ^ $FF
 }
@@ -38,18 +38,18 @@ upstartEnd:
 .assert "neg(%10101010) gives %01010101", neg(%10101010), %01010101
 
 /*
- * Increases argument by one preserving its type (addressing mode). To be used in pseudocommands.
- *
- * Params:
- * arg: mnemonic argument
- */
+  Increases argument by one preserving its type (addressing mode). To be used in pseudocommands.
+
+  Params:
+  arg: mnemonic argument
+*/
 .function incArgument(arg) {
   .return CmdArgument(arg.getType(), arg.getValue() + 1)
 }
 
 /*
- * "Far" bne branch. Depending on the jump length it either does bne or beq/jmp trick.
- */
+  "Far" bne branch. Depending on the jump length it either does bne or beq/jmp trick.
+*/
 .macro fbne(label) {
   here: // we have to add 2 to "here", because relative jump is counted right after bne xx, and this instruction takes 2 bytes
     .if (here > label) {
@@ -74,8 +74,8 @@ upstartEnd:
 }
 
 /*
- * "Far" bmi branch. Depending on the jump length it either does bne or beq/jmp trick.
- */
+  "Far" bmi branch. Depending on the jump length it either does bne or beq/jmp trick.
+*/
 .macro fbmi(label) {
   here: // we have to add 2 to "here", because relative jump is counted right after bne xx, and this instruction takes 2 bytes
     .if (here > label) {
@@ -102,8 +102,8 @@ upstartEnd:
 }
 
 /*
- * Convert kbytes to bytes.
- */
+  Convert kbytes to bytes.
+*/
 .function toBytes(value) {
   .return value * 1024
 }

lib/invoke.asm

@@ -16,12 +16,12 @@
 .filenamespace c128lib
 
 /*
- * Preserves return address that is used with JSR.
- * Should be called at beginning of subroutine.
- *
- * Params:
- * placeholderPtr - pointer to the memory location (that is local variable of the subroutine)
- *                  where return address will be preserved.
+  Preserves return address that is used with JSR.
+  Should be called at beginning of subroutine.
+
+  Params:
+  placeholderPtr - pointer to the memory location (that is local variable of the subroutine)
+                   where return address will be preserved.
  */
 .macro invokeStackBegin(placeholderPtr) {
   pla
@@ -31,13 +31,13 @@
 }
 
 /*
- * Restores return address that will be then used with RTS.
- * Should be called at the very end of subroutine just before RTS.
- *
- * Params:
- * placeholderPtr - pointer to the memory location (that is local variable of the subroutine)
- *                  from where return address will be restored.
- */
+  Restores return address that will be then used with RTS.
+  Should be called at the very end of subroutine just before RTS.
+
+  Params:
+  placeholderPtr - pointer to the memory location (that is local variable of the subroutine)
+                   from where return address will be restored.
+*/
 .macro invokeStackEnd(placeholderPtr) {
   lda placeholderPtr + 1
   pha
@@ -46,81 +46,81 @@
 }
 
 /*
- * Pushes byte value as a parameter to the subroutine.
- * Such value should be then pulled in subroutine in opposite order.
- *
- * Params:
- * value - byte value of the parameter for subroutine
- */
+  Pushes byte value as a parameter to the subroutine.
+  Such value should be then pulled in subroutine in opposite order.
+
+  Params:
+  value - byte value of the parameter for subroutine
+*/
 .macro pushParamB(value) {
   lda #value
   pha
 }
 
 /*
- * Pushes two bytes value as a parameter to the subroutine.
- * Such value should be then pulled in subroutine in opposite order.
- *
- * Params:
- * value - word value of the parameter for subroutine
- */
+  Pushes two bytes value as a parameter to the subroutine.
+  Such value should be then pulled in subroutine in opposite order.
+
+  Params:
+  value - word value of the parameter for subroutine
+*/
 .macro pushParamW(value) {
   pushParamB(<value)
   pushParamB(>value)
 }
 
 /*
- * Pushes byte pointed by an address as a parameter to the subroutine.
- * Such value should be then pulled in subroutine in opposite order.
- *
- * Params:
- * ptr - pointer to the byte value of the parameter for subroutine
- */
+  Pushes byte pointed by an address as a parameter to the subroutine.
+  Such value should be then pulled in subroutine in opposite order.
+
+  Params:
+  ptr - pointer to the byte value of the parameter for subroutine
+*/
 .macro pushParamBInd(ptr) {
   lda ptr
   pha
 }
 
 /*
- * Pushes two bytes value pointed by an address as a parameter to the subroutine.
- * Such value should be then pulled in subroutine in opposite order.
- *
- * Params:
- * ptr - pointer to the two bytes value of the parameter for subroutine
- */
+  Pushes two bytes value pointed by an address as a parameter to the subroutine.
+  Such value should be then pulled in subroutine in opposite order.
+
+  Params:
+  ptr - pointer to the two bytes value of the parameter for subroutine
+*/
 .macro pushParamWInd(ptr) {
   pushParamBInd(ptr)
   pushParamBInd(ptr + 1)
 }
 
 /*
- * Pulls byte value from the stack and stores it under given address.
- *
- * Params:
- * placeholderPtr - pointer to the memory location where given byte will be pulled to
- */
+  Pulls byte value from the stack and stores it under given address.
+
+  Params:
+  placeholderPtr - pointer to the memory location where given byte will be pulled to
+*/
 .macro pullParamB(placeholderPtr) {
   pla
   sta placeholderPtr
 }
 
 /*
- * Pulls two bytes value from the stack and stores it under given address.
- *
- * Params:
- * placeholderPtr - pointer to the beginning of memory location where given two bytes will be pulled to
- */
+  Pulls two bytes value from the stack and stores it under given address.
+
+  Params:
+  placeholderPtr - pointer to the beginning of memory location where given two bytes will be pulled to
+*/
 .macro pullParamW(placeholderPtr) {
   pullParamB(placeholderPtr + 1)
   pullParamB(placeholderPtr)
 }
 
 /*
- * Pulls two bytes value from the stack and stores it under provided addresses.
- *
- * Params:
- *   placeholderPtrList - List of memory locations, where given two byte value will be stored
- */
+  Pulls two bytes value from the stack and stores it under provided addresses.
+
+  Params:
+    placeholderPtrList - List of memory locations, where given two byte value will be stored
+*/
 .macro pullParamWList(placeholderPtrList) {
   .assert "list must be non empty", placeholderPtrList.size() > 0, true
   pla

lib/kernal.asm

@@ -63,4 +63,4 @@
 .label SCRORG     = $FFED   // get current screen window size
 .label PLOT       = $FFF0   // set or read cursor position
                             // now uses $e4 - $ee, editor parameters
-.label JIOBASE    = $FFF3                            
+.label JIOBASE    = $FFF3