Merge branch 'feature/documentation' into 'develop'

Tidied up comments for docgen.

Added some documentation to Asuro.pas, ProgManager, AHCI, asfs & ATA_ISR to fix some of the pasdoc/docgen issues.

See merge request spexeah/asuro!22

compile_vergen.sh

@@ -24,26 +24,30 @@ nasmversion=$(nasm -v | awk '{print $3'})
 compiledate=$(date +"%d/%m/%y")
 compiletime=$(date +"%T")
 checksum=$(md5sum checksums.md5 | awk '{print $1}')
-echo "unit asuro;" > $outfile
+echo "{" > $outfile
+echo "   asuro.pas - Constants generated during pipeline/compilation for use at runtime." >> $outfile
+echo "   @author(Autogenerated)" >> $outfile
+echo "}" >> $outfile
+echo "unit asuro;" >> $outfile
 echo " " >> $outfile
 echo "interface" >> $outfile
 echo " " >> $outfile
 echo "const" >> $outfile
-echo "     VERSION       = '$major.$minor.$sub-$revision$release';" >> $outfile
+echo "     VERSION       = '$major.$minor.$sub-$revision$release'; //The current full version as a string." >> $outfile
-echo "     VERSION_MAJOR = '$major';" >> $outfile
+echo "     VERSION_MAJOR = '$major'; // Current major version as a string." >> $outfile
-echo "     VERSION_MINOR = '$minor';" >> $outfile
+echo "     VERSION_MINOR = '$minor'; // Current minor version as a string." >> $outfile
-echo "     VERSION_SUB   = '$sub';" >> $outfile
+echo "     VERSION_SUB   = '$sub'; // Current sub version as a string." >> $outfile
-echo "     REVISION      = '$revision';" >> $outfile
+echo "     REVISION      = '$revision'; // Current revision as a string." >> $outfile
-echo "     RELEASE       = '$release';" >> $outfile
+echo "     RELEASE       = '$release'; // Current release as a string." >> $outfile
-echo "     LINE_COUNT    = $linecount;" >> $outfile
+echo "     LINE_COUNT    = $linecount; // Project line count as compiled as a string." >> $outfile
-echo "     FILE_COUNT    = $sourcecount;" >> $outfile
+echo "     FILE_COUNT    = $sourcecount; // Project line count as compiled as a string." >> $outfile
-echo "     DRIVER_COUNT  = $drivercount;" >> $outfile
+echo "     DRIVER_COUNT  = $drivercount; // Number of baked drivers in the current binary." >> $outfile
-echo "     FPC_VERSION   = '$fpcversion';" >> $outfile
+echo "     FPC_VERSION   = '$fpcversion'; // Version of the FreePascal Compiler used to compile the current binary." >> $outfile
-echo "     NASM_VERSION  = '$nasmversion';" >> $outfile
+echo "     NASM_VERSION  = '$nasmversion'; // Version of the Netwide Assembler used to compile the multiboot stub." >> $outfile
-echo "     MAKE_VERSION  = '$makeversion';" >> $outfile
+echo "     MAKE_VERSION  = '$makeversion'; // Version of MAKE used to link the current binary." >> $outfile
-echo "     COMPILE_DATE  = '$compiledate';" >> $outfile
+echo "     COMPILE_DATE  = '$compiledate'; // Date in which the current binary was compiled." >> $outfile
-echo "     COMPILE_TIME  = '$compiletime';" >> $outfile
+echo "     COMPILE_TIME  = '$compiletime'; // Time in which the current binary was compiled." >> $outfile
-echo "     CHECKSUM      = '$checksum';" >> $outfile
+echo "     CHECKSUM      = '$checksum'; // MD5 pseduo-checksum of all of the sourcefiles together." >> $outfile
 echo " " >> $outfile
 echo "implementation" >> $outfile
 echo " " >> $outfile

src/driver/storage/AHCI.pas

@@ -12,15 +12,11 @@
 //  See the License for the specific language governing permissions and
 //  limitations under the License.
 
-{ ************************************************
+{ 
-  * Asuro
+	Drivers->Storage->AHCI - AHCI SATA Driver.
-  * Unit: Drivers/AHCI
-  * Description: AHCI SATA Driver
-  ************************************************
-  * Author: Aaron Hance
-  * Contributors: 
-  ************************************************ }
 	
+	@author(Aaron Hance <ah@aaronhance.me>)
+}
 unit AHCI;
 
 interface

src/driver/storage/ATA_ISR.pas

@@ -12,15 +12,11 @@
 //  See the License for the specific language governing permissions and
 //  limitations under the License.
 
-{ ************************************************
+{ 
-  * Asuro
+	Drivers->Storage->ATA_ISR - Primary ATA IRQ.
-  * Unit: Drivers/ISR46
-  * Description: Primary ATA IRQ
-  ************************************************
-  * Author: Aaron Hance
-  * Contributors: 
-  ************************************************ }
 	
+	@author(Aaron Hance <ah@aaronhance.me>)
+}
 unit ATA_ISR;
 
 interface

src/driver/storage/asfs.pas

@@ -12,16 +12,11 @@
 //  See the License for the specific language governing permissions and
 //  limitations under the License.
 
-{ ************************************************
+{ 
-  * Asuro
+	Drivers->Storage->ASFS - Asuro Filesystem Driver.
-  * Unit: Drivers/storage/asfs
-  * Description: asfs file system driver
-  * 
-  ************************************************
-  * Author: Aaron Hance
-  * Contributors: 
-  ************************************************ }
 	
+	@author(Aaron Hance <ah@aaronhance.me>)
+}
 unit asfs;
 
 interface

src/progmanager.pas

@@ -12,6 +12,11 @@
 //  See the License for the specific language governing permissions and
 //  limitations under the License.
 
+{ 
+	ProgManager - Central initialization for terminal registered, baked-in programs.
+	
+	@author(Kieron Morris <kjm@kieronmorris.me>)
+}
 unit progmanager;
 
 interface
@@ -23,6 +28,7 @@ uses
     edit, netlog, themer,
     memview, udpcat, dhclient, vbeinfo;
 
+{ Initialize all baked-in programs }
 procedure init();
 
 implementation