Nasal api doc.py: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 2: | Line 2: | ||
Adrian came up with a simple Nasal API file for $FG_ROOT/Nasal using a python script, he uploaded the file [http://ompldr.org/vY2hmYw/nasal_api.html here] | Adrian came up with a simple Nasal API file for $FG_ROOT/Nasal using a python script, he uploaded the file [http://ompldr.org/vY2hmYw/nasal_api.html here] | ||
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).<ref>{{cite web | |||
|url = https://forum.flightgear.org/viewtopic.php?p=177299#p177299 | |||
|title = <nowiki> Re: Canvas API documentation </nowiki> | |||
|author = <nowiki> Hooray </nowiki> | |||
|date = Feb 15th, 2013 | |||
|added = Feb 15th, 2013 | |||
|script_version = 0.40 | |||
}}</ref> | |||
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. | 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. | ||
Revision as of 15:22, 24 February 2017
| This article is a stub. You can help the wiki by expanding it. |
Adrian came up with a simple Nasal API file for $FG_ROOT/Nasal using a python script, he uploaded the file here
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).[1]
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.[2]
References
References
|