Kernel version 0.8 : Docs...

2025-01-03 18:30:20 +00:00 · 2016-10-22 21:47:40 +02:00 · 2016-10-22 21:47:40 +02:00 · 643f7a549a
commit 643f7a549a
parent 79c7d050fd
1 changed files with 59 additions and 50 deletions
--- a/_Docs/KERNEL.md
+++ b/_Docs/KERNEL.md
@ -1,63 +1,72 @@
 *** Auto generated by docgen.cmd ***  
 #K.FOPEN  
- Open a file  
+ Open a file  
 ##In :  
- PUSHW = AUXTYPE  
- PUSHB = TYPE  
- PUSHB = MODE  
-  SYS.FOPEN.R			.EQ $01			if R and exists -> ERROR  
-  SYS.FOPEN.W			.EQ $02			if W and exists -> CREATE  
-  SYS.FOPEN.A			.EQ $04			Append  
-  SYS.FOPEN.T			.EQ $08			Open/Append in Text mode  
-  SYS.FOPEN.X			.EQ $80			Create if not exists  
- PUSHW = PATH (PSTR)  
+ PUSHW = AUXTYPE  
+ PUSHB = TYPE  
+ PUSHB = MODE  
+ + SYS.FOPEN.R	 : if R and exists -> ERROR  
+ + SYS.FOPEN.W	 : if W and exists -> CREATE  
+ + SYS.FOPEN.A	 : Append  
+ + SYS.FOPEN.T	 : Open/Append in Text mode  
+ + SYS.FOPEN.X	 : Create if not exists  
+ PUSHW = PATH (PSTR)  
 ##Out :   
- CC : A = hFILE  
- CS : A = EC  
-#K.PStrMatch  
- Compare a String against pattern  
-##In:   
-  PUSHW = PTR to Pattern (e.g. '*test?.txt')  
-  PUSHW = PTR to Src String   
-##Out:   
-  CC : match  
-CS : no match  
-#K.PStrUprYA  
- Convert string to UPPERCASE  
-#K.PStrLwrYA  
- Convert string to lowercase  
+ CC : A = hFILE  
+ CS : A = EC  
+#K.NewPStrYA  
+Create a new copy of PSTR  
 ##In:  
-Y,A = PTR to String (PSTRING)  
+ Y,A = PTR to buffer  
 ##Out:  
-  Uppercased/lowercased String in Buffer  
+ CC : success   
+ + Y,A = PTR to String  
+ + X = hMem (PSTRING)  
+ CS : error  
+ + A = SYS error code  
+#K.PStrMatch  
+Compare a String against pattern  
+##In:   
+ + PUSHW = PTR to Pattern (e.g. '*test?.txt')  
+ + PUSHW = PTR to Src String   
+##Out:   
+ + CC : match  
+ + CS : no match  
+#K.PStrUprYA/K.PStrLwrYA  
+Convert string to UPPERCASE/lowercase  
+##In:  
+ + Y,A = PTR to String (PSTRING)  
+##Out:  
+ + Uppercased/lowercased String in Buffer  
 #K.PStrFTime  
 Convert S.TIME struct to PSTR  
 ##In :   
- PUSHW = Dst PTR To PSTR Buf  
- PUSHW = Src PTR To Format String  
-  %a Abbreviated weekday name : Thu  
-%A Full weekday name : Thursday   
-%b Abbreviated month name : Aug   
-%B Full month name : August   
-%d Day of the month, zero-padded (01-31)  
-%H Hour in 24h format (00-23) 14   
-%I Hour in 12h format (01-12) 02   
-%m Month as a decimal number (01-12) 08   
-%M Minute (00-59) 55   
-%p AM or PM designation PM   
-%S Second (00-61) 02   
-%w Weekday as a decimal number with Sunday as 0 (0-6)   
-%y Year, last two digits (00-99)  
-%Y Year four digits 2001   
- PUSHW = Src PTR To S.Time  
+ PUSHW = Dst PTR To PSTR Buf  
+ PUSHW = Src PTR To Format String  
+ + %a : Abbreviated weekday name : Thu  
+ + %A : Full weekday name : Thursday   
+ + %b : Abbreviated month name : Aug   
+ + %B : Full month name : August   
+ + %d : Day of the month, zero-padded (01-31)  
+ + %H : Hour in 24h format (00-23) 14   
+ + %I : Hour in 12h format (01-12) 02   
+ + %m : Month as a decimal number (01-12) 08   
+ + %M : Minute (00-59) 55   
+ + %p : AM or PM designation PM   
+ + %S : Second (00-61) 02   
+ + %w : Weekday as a decimal number with Sunday as 0 (0-6)   
+ + %y : Year, last two digits (00-99)  
+ + %Y : Year four digits 2001   
+ PUSHW = Src PTR To S.Time  
 ##Out :  
-  none. always succeed.  
+ + none. always succeed.  
 #K.PStr2StrArrayYA  
+Convert a PSTR (e.g. : command Line) to a Array of PSTRs (Args[])  
 ##In :   
- Y,A = PTR to String  
+ Y,A = PTR to String  
 ##Out :  
- CC : success  
- Y,A = PTR to StrArray  
- X = hMem  
- CS : error  
- A = SYS error code  
+ CC : success  
+ + Y,A = PTR to StrArray  
+ + X = hMem  
+ CS : error  
+ + A = SYS error code