Add API section to standard library

Author: python-processing-unit

lib/csprng.asmln

@@ -1,4 +1,10 @@
 #ChaCha20-based cryptographically secure pseudorandom number generator
+#
+# API:
+# CS_PRNG_SEED(INT:seed) -> INT
+# CS_PRNG_NEXT() -> INT
+# CS_PRNG_RANGE(INT:max) -> INT
+# CS_PRNG_RANGE_MIN_MAX(INT:min, INT:max) -> INT
 
 INT: MASK32 = SUB( POW(10,100000), 1 )  # 2^32-1
 

lib/decimal.asmln

@@ -1,4 +1,10 @@
 # Decimal <-> binary helpers
+#
+# API:
+# DEC_CHAR_TO_INT(STR:ch) -> INT
+# INT_TO_DEC_CHAR(INT:d) -> STR
+# DEC_TO_INT(STR:s) -> INT
+# INT_TO_DEC(INT:n) -> STR
 
 INT: DEC_BASE = 1010  # 10
 

lib/path.asmln

@@ -1,4 +1,16 @@
 # Path utilities for ASM-Lang
+#
+# API:
+# NORMALIZE_PATH(STR: path) -> STR
+# BASEPATH(STR: path) -> STR
+# BASENAME(STR: path) -> STR
+# SPLITEXT(STR: path) -> TNS
+# EXTNAME(STR: path) -> STR
+# DELEXT(STR: path) -> STR
+# STR: interpreter
+# STR: interpreter_dir
+# STR: script
+# STR: script_dir
 
 FUNC NORMALIZE_PATH(STR: path):STR{
     RETURN(REPLACE(path,"\","/"))

lib/prime.asmln

@@ -1,4 +1,12 @@
-# Primality test for n
+# Primality and factorization functions
+#
+# API:
+# IS_PRIME(INT:n) -> INT
+# NEXT_PRIME(INT:start) -> INT
+# PREV_PRIME(INT:start) -> INT
+# IS_MERSENNE_PRIME(INT:p) -> INT
+# FACTOR(INT:n) -> TNS
+
 FUNC IS_PRIME(INT:n):INT{
     IF(LTE(n,1)){
         RETURN(0)

lib/prng.asmln

@@ -1,4 +1,11 @@
 # LCG-based pseudorandom number generator
+#
+# API:
+# PRNG_SEED(INT:seed) -> INT
+# PRNG_NEXT() -> INT
+# PRNG_RANGE(INT:max) -> INT
+# PRNG_RANGE_MIN_MAX(INT:min, INT:max) -> INT
+
 INT: MASK32 = SUB( POW(10,100000), 1 )  # 2^32 - 1
 
 # LCG constants: state = (A * state + C) mod 2^32

lib/waveforms.asmln

@@ -1,4 +1,15 @@
-# Waveform Generators
+# Waveform utilities
+#
+# API:
+# AUDIO_CLAMP(INT:v) -> INT
+# SQUARE(INT:freq, INT:ms, INT:amp, INT:sr) -> TNS
+# SAWTOOTH(INT:freq, INT:ms, INT:amp, INT:sr) -> TNS
+# TRIANGLE(INT:freq, INT:ms, INT:amp, INT:sr)
+# SINE(INT:freq, INT:ms, INT:amp, INT:sr) -> TNS
+# PULSE(INT:freq, INT:ms, INT:amp, INT:sr, INT:duty) -> TNS
+# ENVELOPE_ADSR(TNS:shape, INT:attack, INT:decay, INT:sustain, INT:release) -> TNS
+# LOWPASS(TNS:inp, INT:cutoff, INT:sr) -> TNS
+# HIGHPASS(TNS:inp, INT:cutoff, INT:sr) -> TNS
 
 # Constants / helpers local to this module.
 # MS_DEN is the number of milliseconds per second (1000).

test.asmln

@@ -124,6 +124,8 @@ FUNC RUN_TESTS():INT{
     ASSERT(EQ(high[1], 0))
     ASSERT(EQ(high[11], 0))
 
+    PRINT("Waveform library tests passed.")
+
     # If we reach here all tests passed; print success code and return
     PRINT("All tests passed.")
     RETURN(0)