Irrlicht API Documentation Search function

Discuss about anything related to the Irrlicht Engine, or read announcements about any significant features or usage changes.

Irrlicht API Documentation Search function

Postby ACE247 » Mon Oct 31, 2011 4:23 am

Irrlichts API Documentation is really well made, however it does appear lacking a search function to find those important little details hiding someplace in there.
So without further ado I just paste this link here so you can find those details.

Irrlicht API search Engine
H8L6L5M4G3H5M7N8S7N9O1R8J1P5M7N9O4P2Q5R6T7U4M3N8X6S5T8W (If you want the secret, why not 'TRY' decrypting it? )
This Door's lock doesn't need a key, the Lock is the key to open the Lock and you don't know how to turn the key...
Link: My Blog :)
User avatar
ACE247
 
Posts: 695
Joined: Tue Mar 16, 2010 12:31 am
Location: Namibia

Re: Irrlicht API Documentation Search function

Postby Virror » Mon Oct 31, 2011 8:39 am

Maybe this could be integrated into the API-page?
Virror
 
Posts: 191
Joined: Mon May 02, 2011 3:15 pm

Re: Irrlicht API Documentation Search function

Postby mongoose7 » Mon Oct 31, 2011 10:15 am

You can do the same anytime you want just by using the 'site:' keyword.
mongoose7
 
Posts: 514
Joined: Wed Apr 06, 2011 12:13 pm

Re: Irrlicht API Documentation Search function

Postby hybrid » Mon Oct 31, 2011 12:17 pm

Yeah, but a proper edit box with this one preset is of course helpful. But as it seems, doxygen now also has a search engine inside. Will check this on the next update when we will also move to doxygen 1.7.x
hybrid
Admin
 
Posts: 13943
Joined: Wed Apr 19, 2006 9:20 pm
Location: Oldenburg(Oldb), Germany

Re: Irrlicht API Documentation Search function

Postby hybrid » Tue Nov 01, 2011 4:14 pm

Ok, short update. I tested the update to doxygen 1.7.x and also updated the header and footer files this time. This means larger layout changes and a completely different style. But IMHO also far better usage and comprehensiveness. Moreover, also an integrated search function. Just check it out yourself. I've copied a version to the SF servers. Just note that this link won't be permanent. Once we figured out the proper style and with the next release of Irrlicht we will overwrite the existing API docs link and remove this temporary one!
http://irrlicht.sourceforge.net/docutemp/index.html
Please report any feedback here. I'll move this topic to Open Discussion. If someone feels that the search function should be kept in the FAQ forum anyway, we can create a new thread afterwards.
BTW: I've noticed that the member lists are not properly working. The layout is completely broken. Could be that I still have a wrong config item enabled, or doxygen has a problem. Or my header files are still not perfect. But something should be done there before we release this.
hybrid
Admin
 
Posts: 13943
Joined: Wed Apr 19, 2006 9:20 pm
Location: Oldenburg(Oldb), Germany

Re: Irrlicht API Documentation Search function

Postby Virror » Wed Nov 02, 2011 9:48 am

I like it! Very nice. Found no other issues than the member thing.
Virror
 
Posts: 191
Joined: Mon May 02, 2011 3:15 pm

Re: Irrlicht API Documentation Search function

Postby teto » Wed Nov 02, 2011 11:28 am

nice indeed
Using trunk with mingw/gcc 4.6, Windows 7 64 bits driver opengl
User avatar
teto
 
Posts: 159
Joined: Thu Dec 03, 2009 9:37 pm
Location: /home

Re: Irrlicht API Documentation Search function

Postby RdR » Wed Nov 02, 2011 1:00 pm

@hybrid,

Looks alot better than the current API documentation imo. Btw why not updating the irrlicht logo ?
User avatar
RdR
Competition winner
 
Posts: 257
Joined: Tue Mar 29, 2011 2:58 pm

Re: Irrlicht API Documentation Search function

Postby hybrid » Wed Nov 02, 2011 4:39 pm

Ah yeah, the logo. It's just the standard one because that was already in the scripts directory from where doxygen gets its data. So basically forgot to change it :wink: Will do next time I play around with it.
hybrid
Admin
 
Posts: 13943
Joined: Wed Apr 19, 2006 9:20 pm
Location: Oldenburg(Oldb), Germany

Re: Irrlicht API Documentation Search function

Postby hybrid » Wed Nov 02, 2011 6:12 pm

Update: I found the problem, was a missing stylesheet command in the header of the pages. Logo is now also updated and everything seems to be working. So just wait for the next Irrlicht release. Until then, the temporary docs will stay online - just not being updated to latest SVN/trunk code. So please don't rely on it.
hybrid
Admin
 
Posts: 13943
Joined: Wed Apr 19, 2006 9:20 pm
Location: Oldenburg(Oldb), Germany

Re: Irrlicht API Documentation Search function

Postby ACE247 » Wed Nov 02, 2011 6:33 pm

Wow looking great now! :) Going to be hard though, 'not to rely on it', the new docs are WAAAY better!
H8L6L5M4G3H5M7N8S7N9O1R8J1P5M7N9O4P2Q5R6T7U4M3N8X6S5T8W (If you want the secret, why not 'TRY' decrypting it? )
This Door's lock doesn't need a key, the Lock is the key to open the Lock and you don't know how to turn the key...
Link: My Blog :)
User avatar
ACE247
 
Posts: 695
Joined: Tue Mar 16, 2010 12:31 am
Location: Namibia

Re: Irrlicht API Documentation Search function

Postby hybrid » Wed Nov 02, 2011 9:42 pm

Well, it should stay there until we have a complete version online. So you just cannot rely on it being updated continuously. But besides that, it's good to use.
hybrid
Admin
 
Posts: 13943
Joined: Wed Apr 19, 2006 9:20 pm
Location: Oldenburg(Oldb), Germany


Return to Open Discussion and Dev Announcements

Who is online

Users browsing this forum: No registered users and 1 guest