Nasal api doc.py: Difference between revisions
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
{{Stub}} | {{Stub}} | ||
there | there is a Python script that parses $FG_ROOT/Nasal to create up-to-date Nasal docs from it, see Adrian's script: [https://forum.flightgear.org/viewtopic.php?f=72&t=25119 viewtopic.php?f=72&t=25119]<ref>{{cite web | ||
|url = https://forum.flightgear.org/viewtopic.php?p=286012#p286012 | |url = https://forum.flightgear.org/viewtopic.php?p=286012#p286012 | ||
|title = <nowiki> Re: </nowiki> | |title = <nowiki> Re: </nowiki> | ||
Revision as of 15:26, 24 February 2017
| This article is a stub. You can help the wiki by expanding it. |
there 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]
there's a dedicated Python script that can help automatically extract most of the boilerplate structure to help create the wiki stub - see Adrian's work[2]
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.[3]
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).[4]
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.[5]
References
References
|