L1VM - documentation
L1VM - documentation
I did add two new flags to the preprocessor:
#docustart
...
#docuend
Inside this block you can add the documentation for the current function or other important stuff.
The preprocessor generates a out.md
Markdown file with the documentation in it. So you can use all the Markdown tags there.
Here is an example (prog/math-circle-bignum.l1com):
(circle object)
#var ~ circle
#docustart
circle object
=============
Calculate diameter, circumference and area of a circle.
init->circle
------------
Set the m_pi Pi variable.
calc_diam->circle
-----------------
Calculate the diameter of a circle.
calc_circ->circle
-----------------
Calculate the circumference of a circle.
calc-area->circle
-----------------
Calculate the area of a circle.
#docuend