20,741
edits
Teaching Doxygen Nasal: Difference between revisions
Jump to navigation
Jump to search
m
no edit summary
mNo edit summary |
mNo edit summary |
||
| Line 5: | Line 5: | ||
=Goals= | =Goals= | ||
* We want to automatically create API docs for $FG_ROOT/Nasal (i.e. the shared Nasal lib). | * We want to automatically create API docs for $FG_ROOT/Nasal (i.e. the shared Nasal lib). | ||
* Nasal is already very close to ECMA/JavaScript | * Nasal is already very close to ECMA/JavaScript, C, C++ and Java (supported by DoxyGen already) | ||
* Ideally, we'll be able to reuse existing tools | * Ideally, we'll be able to reuse existing tools | ||
* such as [ | * such as [http://www.stack.nl/~dimitri/doxygen/index.html doxygen], to automatically parse Nasal code and create API docs | ||
* alternatively, the Nasal parser itself could be used | * alternatively, the Nasal parser itself could be used | ||
* API docs should be hosted at flightgear.org and included as part of each release in $FG_ROOT/Docs | * API docs should be hosted at flightgear.org and included as part of each release in $FG_ROOT/Docs | ||
| Line 26: | Line 26: | ||
We were recently talking about teaching the wiki (GeSHi actually) Nasal, so that syntax highlighting is working properly here. | We were recently talking about teaching the wiki (GeSHi actually) Nasal, so that syntax highlighting is working properly here. | ||
= Related = | |||
* http://www.stack.nl/~dimitri/doxygen/index.html | |||
* http://www.stack.nl/~dimitri/doxygen/manual.html | |||
[[Category:Nasal]] | [[Category:Nasal]] | ||