Nasal api doc.py
This article is a stub. You can help the wiki by expanding it. |
there already is a Python script that parses $FG_ROOT/Nasal to create up-to-date Nasal docs from it, see Adrian's script: viewtopic.php?f=72&t=25119[1]
Adrian came up with a simple Nasal API file for $FG_ROOT/Nasal using a python script, he uploaded the file here
adrian's python script automatically creates Nasal API docs based on parsing $FG_ROOT/Nasal.[2]
Adrian's nasal_api_doc.py script in $FG_SRC/scripts/python should automatically create updated API documentation based on the nasal source code in $FG_ROOT/Nasal (html output).[3]
This is a temporary solution until there's a more solid solution. The reasons Adrian used a home-made parser instead of a pre-made solution is the lack of uniform coding and comment style. There's a lot to be improved, for sure. For one, Adrian would like to extend it further so it can parse classes as well.
Please take a look and comment.[4]
References
References |