Offline API Documentation

CiderSubmarine · Post by **CiderSubmarine** » Mon May 11, 2009 5:17 pm

Hi Everyone,

With the recent forum/site problems I found it difficult to do anything productive in Irrlicht without the API documentation available. As theres literally hundreds of pages I created a script that automatically fetches each individual page and image from URI's that have the general Doxygen structure.

I haven't had the chance to test that everything is 100% spot on but from what I've looked at it seems to work perfectly. While my personal site is in the process of being upgraded I've temporarily uploaded an example to MediaFire. I'll provide a more permanent home when my site is ready.

In the meantime I hope this is useful to someone somewhere.

http://www.mediafire.com/file/ztum2mgj1 ... 0May09.tar

CuteAlien · Post by **CuteAlien** » Mon May 11, 2009 5:45 pm

All that work...

Oh well - next time call scripts/doc/irrlicht/makedocumentation and you get a complete new set of documentation created from the current engine sources ;-)

CiderSubmarine · Post by **CiderSubmarine** » Mon May 11, 2009 6:04 pm

CuteAlien wrote:All that work...

Oh well - next time call scripts/doc/irrlicht/makedocumentation and you get a complete new set of documentation created from the current engine sources

The only documentation I could find with the SDK was in the chm format, something I don't bother with under Linux.

The script (which was only around 80 lines) isn't Irrlicht specific, I created it for other Doxygen based documentation as well so it was worth it (for me at least)

Halan · Post by **Halan** » Sun May 31, 2009 11:05 pm

lol nearly every distro has a chm > html converter.

But I would like to see a html documentation in the next irrlicht release if possible.

hybrid · Post by **hybrid** » Sun May 31, 2009 11:38 pm

Just read what CuteAlien suggested and create your own html files