Nasal api doc.py: Difference between revisions
No edit summary |
No edit summary |
||
Line 7: | Line 7: | ||
|date = May 21st, 2016 | |date = May 21st, 2016 | ||
|added = May 21st, 2016 | |added = May 21st, 2016 | ||
|script_version = 0.40 | |||
}}</ref> | |||
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<ref>{{cite web | |||
|url = https://forum.flightgear.org/viewtopic.php?p=304161#p304161 | |||
|title = <nowiki> Re: Canvas GUI API documentation in wiki </nowiki> | |||
|author = <nowiki> Hooray </nowiki> | |||
|date = Jan 25th, 2017 | |||
|added = Jan 25th, 2017 | |||
|script_version = 0.40 | |script_version = 0.40 | ||
}}</ref> | }}</ref> |
Revision as of 15:25, 24 February 2017
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]
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
|