List functions in alphabetical order for easier browsing

What it says on the tin: a place to discuss proposed new features.
Post Reply
User avatar
petrocket
Gremlin
Posts: 178
Joined: Tue Mar 20, 2007 3:29 am
x 10
Contact:

List functions in alphabetical order for easier browsing

Post by petrocket »

Maybe this is just me but whenever I go to the API or open an Ogre .h or .cpp file I always miss that the functions are not in alphabetical order to easily find a function or to find one when you can't quite remember the name. Sure- if you have the Ogre Solution open you can look in Visual Studio's Class View to see the functions in alphabetical order...but usually I only have my own solution open and I'm referencing the API, or an Ogre header file and having to hit Ctrl+f all the time to search for a function is inconvenient.

I know this would be a chore - but if I re-ordered the functions to be alphabetical would that make it bad for anyone? Or is there any way to at least make the HTML API list the class members and member functions in alphabetical order? Like on this page: http://www.ogre3d.org/docs/api/html/cla ... eNode.html You're looking for getParentSceneNode and you have to Ctrl+f for it because browsing for it takes too long (long file) - sure if you know better you can hit the 'List of all members' link.

I'm aware that you can hit the 'List of all members' link and if shows an alphabetical list, but that is not the default view and it doesn't display all the extra description information that the default view does.
Ogre API & Manual | Ogre Wiki

blog | website | work

Follow me on twitter @ twitter.com/petrocket
User avatar
haffax
OGRE Retired Moderator
OGRE Retired Moderator
Posts: 4823
Joined: Fri Jun 18, 2004 1:40 pm
Location: Berlin, Germany
x 8
Contact:

Re: List functions in alphabetical order for easier browsing

Post by haffax »

Having members in the header files sorted is out of question. For development other criteria are more important, like having getters/setters or members for the same functionality next to each other.

You can just recreate the docs yourself. Download doxygen and edit the doxyfile (Docs/src/html.cfg) to order members as you want them.
team-pantheon programmer
creators of Rastullahs Lockenpracht
User avatar
nullsquared
Old One
Posts: 3245
Joined: Tue Apr 24, 2007 8:23 pm
Location: NY, NY, USA
x 11

Re: List functions in alphabetical order for easier browsing

Post by nullsquared »

I use firefox + the "search when you type" feature. Basically, you're on a page, and you type stuff, and it automatically searches for it. Then you can just hit enter on whatever it finds, regardless of whether you typed in the full name when searching. This is very useful because I can just do "scenen" -> enter -> "getParentS" -> enter and I'm at SceneNode::getParentSceneNode()'s page.
User avatar
Praetor
OGRE Retired Team Member
OGRE Retired Team Member
Posts: 3335
Joined: Tue Jun 21, 2005 8:26 pm
Location: Rochester, New York, US
x 3
Contact:

Re: List functions in alphabetical order for easier browsing

Post by Praetor »

I wonder if doxygen has an option to automatically do this.
Game Development, Engine Development, Porting
http://www.darkwindmedia.com
Vectrex
Ogre Magi
Posts: 1266
Joined: Tue Aug 12, 2003 1:53 am
Location: Melbourne, Australia
x 1
Contact:

Re: List functions in alphabetical order for easier browsing

Post by Vectrex »

if you're serious for Visual Studio buy Visual assist. It has a ton of great features for rapidly finding things
Post Reply