Nasal api doc.py

From FlightGear wiki
Revision as of 15:22, 24 February 2017 by Hooray (talk | contribs)
Jump to navigation Jump to search
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
  1. Hooray  (Feb 15th, 2013).  Re: Canvas API documentation .
  2. adrian  (Jan 27th, 2012).  .