Spexeah/Asuro
3
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge branch 'feature/documentation' into 'develop'

Browse Source 
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
This commit is contained in:
Kieron
2021-07-05 18:09:51 +00:00
parent e07dcf63af 439d4ef8ac
commit 4d25ceef77
5 changed files with 41 additions and 44 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
compile_vergen.sh
View File

@@ -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 = '$major';" >> $outfile
echo " VERSION_MINOR = '$minor';" >> $outfile
echo " VERSION_SUB = '$sub';" >> $outfile
echo " REVISION = '$revision';" >> $outfile
echo " RELEASE = '$release';" >> $outfile
echo " LINE_COUNT = $linecount;" >> $outfile
echo " FILE_COUNT = $sourcecount;" >> $outfile
echo " DRIVER_COUNT = $drivercount;" >> $outfile
echo " FPC_VERSION = '$fpcversion';" >> $outfile
echo " NASM_VERSION = '$nasmversion';" >> $outfile
echo " MAKE_VERSION = '$makeversion';" >> $outfile
echo " COMPILE_DATE = '$compiledate';" >> $outfile
echo " COMPILE_TIME = '$compiletime';" >> $outfile
echo " CHECKSUM = '$checksum';" >> $outfile
echo " VERSION = '$major.$minor.$sub-$revision$release'; //The current full version as a string." >> $outfile
echo " VERSION_MAJOR = '$major'; // Current major version as a string." >> $outfile
echo " VERSION_MINOR = '$minor'; // Current minor version as a string." >> $outfile
echo " VERSION_SUB = '$sub'; // Current sub version as a string." >> $outfile
echo " REVISION = '$revision'; // Current revision as a string." >> $outfile
echo " RELEASE = '$release'; // Current release as a string." >> $outfile
echo " LINE_COUNT = $linecount; // Project line count as compiled as a string." >> $outfile
echo " FILE_COUNT = $sourcecount; // Project line count as compiled as a string." >> $outfile
echo " DRIVER_COUNT = $drivercount; // Number of baked drivers in the current binary." >> $outfile
echo " FPC_VERSION = '$fpcversion'; // Version of the FreePascal Compiler used to compile the current binary." >> $outfile
echo " NASM_VERSION = '$nasmversion'; // Version of the Netwide Assembler used to compile the multiboot stub." >> $outfile
echo " MAKE_VERSION = '$makeversion'; // Version of MAKE used to link the current binary." >> $outfile
echo " COMPILE_DATE = '$compiledate'; // Date in which the current binary was compiled." >> $outfile
echo " COMPILE_TIME = '$compiletime'; // Time in which the current binary was compiled." >> $outfile
echo " CHECKSUM = '$checksum'; // MD5 pseduo-checksum of all of the sourcefiles together." >> $outfile
echo " " >> $outfile
echo "implementation" >> $outfile
echo " " >> $outfile

14
src/driver/storage/AHCI.pas
View File

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

14
src/driver/storage/ATA_ISR.pas
View File

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

15
src/driver/storage/asfs.pas
View File

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

6
src/progmanager.pas
View File

@@ -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