kripken / intensityengine

[Not active!] An open source platform for 3D games and virtual worlds
https://web.archive.org/web/20100222011320/http://www.syntensity.com/
Other
58 stars 15 forks source link

Update to API documentation #9

Closed ghost closed 14 years ago

ghost commented 14 years ago

The API documentation has the following issues:

I can't submit a patch because I don't know what changes you want to make.

ghost commented 14 years ago

Similarly, the doc URL here is likely out of date: http://syntensity.blogspot.com/2009/09/intensity-engine-api-documentation.html

I know this stuff isn't that important, just recording it here so you can get to it when you have some free time.

kripken commented 14 years ago

Fixed the blog link.

Not sure about the other stuff. I see 2010, not 2009, in docs/scripting_docs.html. What file are you specifically looking at?

ghost commented 14 years ago

Ah sorry, I'm referring to the API documentation generaetd by doxygen. See:

When I say "Main Page", I am referring to the label used in the generated documentation (it comes from the init.py file). Looking at the generated documentation, the issues become obvious.

kripken commented 14 years ago

Ok, I did some cleanup there, but really what I should eventually do is properly document the JavaScript API (which is more important than the Python stuff).