Fixing version and other files

Author: intoinside

CONTRIBUTING.md

@@ -5,7 +5,45 @@ TBD
 
 ## Guide to contributing documentation
 ### File header
-TBD
+Every file should have an header like this:
+
+<pre>
+/**
+ * @file math.asm
+ * @brief Math module
+ * @details Simple macros for math operations.
+ *
+ * @author Raffaele Intorcia <a href="https://github.com/intoinside">@intoinside</a> [email protected]
+ *
+ * @copyright MIT License
+ * Copyright (c) 2024 c128lib - https://github.com/c128lib
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ *
+ * @date 2024
+ */
+</pre>
+
+* a @brief keyword with a short description (typically one or two line)
+* a @details keyword (optional) with a longer description, with some hint about code used and comparison with similar code
+* one or more @author keyword with name, Github profile link and email
+* a @date keyword indicating year of creating file
 
 ### Subroutine and macro header
 Every subroutine and macro should have an header like this:

Doxyfile

@@ -2173,7 +2173,7 @@ MAN_LINKS              = NO
 # captures the structure of the code including all documentation.
 # The default value is: NO.
 
-GENERATE_XML           = YES
+GENERATE_XML           = NO
 
 # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of

lib/cia-global.asm

@@ -45,7 +45,7 @@
  * @remark Register .A will be modified.
  * @remark Flags N and Z will be affected.
  *
- * @since 0.1.0
+ * @since 1.0.0
  */
 .macro c128lib_GetFirePressedPort1() { GetFirePressedPort1() }
 
@@ -59,6 +59,6 @@
  * @remark Register .A will be modified.
  * @remark Flags N and Z will be affected.
  *
- * @since 0.1.0
+ * @since 1.0.0
  */
 .macro c128lib_GetFirePressedPort2() { GetFirePressedPort2() }

lib/cia.asm

@@ -47,7 +47,7 @@
  *
  * @note Use c128lib_GetFirePressedPort1 in cia-global.asm
  *
- * @since 0.1.0
+ * @since 1.0.0
  */
 .macro GetFirePressedPort1() {
   lda Cia.CIA1_DATA_PORT_B
@@ -66,7 +66,7 @@
  *
  * @note Use c128lib_GetFirePressedPort2 in cia-global.asm
  *
- * @since 0.1.0
+ * @since 1.0.0
  */
 .macro GetFirePressedPort2() {
   lda Cia.CIA1_DATA_PORT_A

lib/common-global.asm

@@ -45,7 +45,7 @@
  *
  * @param[in] sysAddress The address to which the BASIC program will SYS to start the machine code part.
  *
- * @since 0.1.0
+ * @since 1.0.0
  */
 .macro c128lib_BasicUpstart128(sysAddress) { BasicUpstart128(sysAddress) }
 
@@ -62,7 +62,7 @@
  *
  * @param[in] label The label to jump to if the zero flag is not set.
  *
- * @since 0.1.0
+ * @since 1.0.0
  */
 .macro c128lib_fbne(label) { fbne(label) }
 
@@ -79,6 +79,6 @@
  *
  * @param[in] label The label to jump to if the negative flag is set.
  *
- * @since 0.1.0
+ * @since 1.0.0
  */
 .macro c128lib_fbmi(label) { fbmi(label) }

lib/common.asm

@@ -49,7 +49,7 @@
  *
  * @note Use c128lib_BasicUpstart128 in common-global.asm
  *
- * @since 0.1.0
+ * @since 1.0.0
  */
 .macro BasicUpstart128(sysAddress) {
     .pc = $1c01 "C128 Basic"
@@ -78,7 +78,7 @@ upstartEnd:
  *
  * @note Use c128lib_fbne in common-global.asm
  *
- * @since 0.1.0
+ * @since 1.0.0
  */
 .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
@@ -118,7 +118,7 @@ upstartEnd:
  *
  * @note Use c128lib_fbmi in common-global.asm
  *
- * @since 0.1.0
+ * @since 1.0.0
  */
  .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

lib/io-global.asm

@@ -47,7 +47,7 @@
  * @remark Register .A, .X and .Y will be modified.
  * @remark Flags N and Z will be affected.
  *
- * @since 0.1.0
+ * @since 1.0.0
  */
 .macro c128lib_OpenIOChannel(filenumber, devicenumber, secondary) { OpenIOChannel(filenumber, devicenumber, secondary) }
 
@@ -62,7 +62,7 @@
  * @remark Register .A, .X and .Y will be modified.
  * @remark Flags N and Z will be affected.
  *
- * @since 0.1.0
+ * @since 1.0.0
  */
 .macro c128lib_SetIOName(length, address) { SetIOName(length, address) }
 
@@ -77,7 +77,7 @@
  *
  * @note Use c128lib_SetInputChannel in io-global.asm
  *
- * @since 0.1.0
+ * @since 1.0.0
  */
 .macro c128lib_SetInputChannel(filenumber) { SetInputChannel(filenumber) }
 
@@ -90,7 +90,7 @@
  * @remark Register .X will be modified.
  * @remark Flags N and Z will be affected.
  *
- * @since 0.1.0
+ * @since 1.0.0
  */
 .macro c128lib_SetOutputChannel(filenumber) { SetOutputChannel(filenumber) }
 
@@ -106,6 +106,6 @@
  * @param[in] devicenumber The device number for the I/O channel.
  * @param[in] secondary The secondary address for the I/O channel.
  *
- * @since 0.1.0
+ * @since 1.0.0
  */
 .macro c128lib_OpenFile(length, address, filenumber, devicenumber, secondary) { OpenFile(length, address, filenumber, devicenumber, secondary) }

lib/io.asm

@@ -49,7 +49,7 @@
  *
  * @note Use c128lib_OpenIOChannel in io-global.asm
  *
- * @since 0.1.0
+ * @since 1.0.0
  */
 .macro OpenIOChannel(filenumber, devicenumber, secondary) {
   lda #filenumber
@@ -74,7 +74,7 @@
  *
  * @note Use c128lib_SetIOName in io-global.asm
  *
- * @since 0.1.0
+ * @since 1.0.0
  */
 .macro SetIOName(length, address) {
   lda #length
@@ -97,7 +97,7 @@
  *
  * @note Use c128lib_SetInputChannel in io-global.asm
  *
- * @since 0.1.0
+ * @since 1.0.0
  */
 .macro SetInputChannel(filenumber) {
   ldx #filenumber
@@ -118,7 +118,7 @@
  *
  * @note Use c128lib_SetOutputChannel in io-global.asm
  *
- * @since 0.1.0
+ * @since 1.0.0
  */
 .macro SetOutputChannel(filenumber) {
   ldx #filenumber
@@ -142,7 +142,7 @@
  *
  * @note Use c128lib_OpenFile in io-global.asm
  *
- * @since 0.1.0
+ * @since 1.0.0
  */
 .macro OpenFile(length, address, filenumber, devicenumber, secondary) {
   SetIOName(length, address)

lib/math-global.asm

@@ -49,7 +49,7 @@
  * @param[in,out] dest The memory location of the other 16-bit value.
  * @returns Result is returned in dest memory location.
  *
- * @since 0.1.0
+ * @since 1.0.0
  */
 .macro c128lib_Add16(value, dest) { Add16(value, dest) }
 
@@ -68,7 +68,7 @@
  * @remark Register .A will be modified.
  * @remark Flags N, O, Z and C will be affected.
  *
- * @since 0.1.0
+ * @since 1.0.0
  */
 .macro c128lib_Sub16(value, dest) { Sub16(value, dest) }
 
@@ -84,7 +84,7 @@
  * @remark Register .A will be modified.
  * @remark Flags N, Z and C will be affected.
  *
- * @since 0.1.0
+ * @since 1.0.0
  */
 .macro c128lib_Asl16(address) { Asl16(address) }
 
@@ -99,7 +99,7 @@
  * @returns Result is returned in address memory location.
  * @remark Flags N and Z will be affected.
  *
- * @since 0.1.0
+ * @since 1.0.0
  */
 .macro c128lib_Inc16(address) { Inc16(address) }
 
@@ -115,7 +115,7 @@
  * @remark Register .A will be modified.
  * @remark Flags N and Z will be affected.
  *
- * @since 0.1.0
+ * @since 1.0.0
  */
 .macro c128lib_Dec16(address) { Dec16(address) }
 
@@ -132,7 +132,7 @@
  * @remark Registers .A, .X and .Y will be modified.
  * @remark Flags N, O, Z and C will be affected.
  *
- * @since 0.1.0
+ * @since 1.0.0
  */
 .macro c128lib_Div16By16(dividend, divisor, remainder) { Div16By16(dividend, divisor, remainder) }
 
@@ -149,6 +149,6 @@
  * @remark Registers .A and .X will be modified.
  * @remark Flags N, O, Z and C will be affected.
  *
- * @since 0.1.0
+ * @since 1.0.0
  */
 .macro c128lib_Div16By8(dividend, divisor, remainder) { Div16By8(dividend, divisor, remainder) }

lib/math.asm

@@ -51,7 +51,7 @@
  *
  * @note Use c128lib_Add16 in math-global.asm
  *
- * @since 0.1.0
+ * @since 1.0.0
  */
  .macro Add16(value, dest) {
   clc
@@ -84,7 +84,7 @@
  *
  * @note Use c128lib_Sub16 in math-global.asm
  *
- * @since 0.1.0
+ * @since 1.0.0
  */
 .macro Sub16(value, dest) {
   sec
@@ -118,7 +118,7 @@
  *
  * @note Use c128lib_Asl16 in math-global.asm
  *
- * @since 0.1.0
+ * @since 1.0.0
  */
 .macro Asl16(address) {
   asl16 address
@@ -148,7 +148,7 @@
  *
  * @note Use c128lib_Inc16 in math-global.asm
  *
- * @since 0.1.0
+ * @since 1.0.0
  */
 .macro Inc16(address) {
   inc16 address
@@ -175,7 +175,7 @@
  *
  * @note Use c128lib_Dec16 in math-global.asm
  *
- * @since 0.1.0
+ * @since 1.0.0
  */
 .macro Dec16(address) {
   dec16 address
@@ -205,7 +205,7 @@
  *
  * @note Use c128lib_div16By16 in math-global.asm
  *
- * @since 0.1.0
+ * @since 1.0.0
  */
 .macro Div16By16(dividend, divisor, remainder) {
     lda #0
@@ -254,7 +254,7 @@
  *
  * @note Use c128lib_Div16By8 in math-global.asm
  *
- * @since 0.1.0
+ * @since 1.0.0
  */
 .macro Div16By8(dividend, divisor, remainder) {
     lda #0