Doxygen API documentation

Having looked at the source code it seems the comments are such that they can be parsed by Doxygen. It would be nice if these where compiled and posted online somewhere for reference. I would find it very useful.

Apologies if they are already placed somewhere but I couldn't find them.

This will sound funny, but the main reason I used that formatting for commenting was because I was following the commenting style I found for the Ogre source. I'm not familiar with Doxygen, although I would like to look into it when I put effort into commenting again. In the very beginning (v0.9.0) I put in a massive effort to comment everything. But with each new version there are massive changes (always for the better!), and there are a lot of places without comments, or incorrect comments.

Its one of the problems with developing the library, there is so much more functionality that is needed, and I really value user feedback, but I don't want to spend time on documentation until the library API is mostly stable. (its getting there..)

For basic functionality and library use, the Demo source is the best documentation we have at the moment. There is also the wiki, which has a few links that have content:

http://www.ogre3d.org/wiki/index.php/QuickGUI

Sorry about this!

Ok well I'm glad you commented it like you did. Running doxygen to parse your files should be very easy then. It's well worth doing it. If you want I can do it for you, just wondering if you have any webspace available to upload the docs? I have a few places where I can host it if you want, but I guess you would be happier having it hosted on your own server somewhere so that you are able to update when convenient for you.

I've seen the demo, and this is of course very useful. But sometimes you just want to see what functions a certain class has, this is where the API docs come in handy (rather than looking at the .h files).

Edit: I went ahead and ran the source code through Doxygen for my own benefit. I decided to upload it temporarily to my webspace so you can see what you are missing .

http://www.nottingham.ac.uk/~epzms1/quickgui/

One of the most useful things that isn't easy to get from the source code is the class hierarchy:

http://www.nottingham.ac.uk/~epzms1/qui ... archy.html

Wow that is awesome! I will run Doxygen over the code and post links to it on the forum and wiki before next release.

Edit: I went ahead and ran the source code through Doxygen for my own benefit. I decided to upload it temporarily to my webspace so you can see what you are missing .

http://www.nottingham.ac.uk/~epzms1/quickgui/

Unfortunately SpaceDude seems to have removed the API, which I actually used a lot when coding, and I can't seem to make Doxygen chew through QuickGUI's source code .

Does anyone have the QuickGUI API online somewhere?

1) It shouldn't be hard to make Doxygen chew through the source, it worked out of the box for me when I did it. What errors are you getting?
2) I think the Doxygen documentation is of little use because the comments are outdated and many of the functions have different parameters now, flat out don't exist, etc.

2) I think the Doxygen documentation is of little use because the comments are outdated and many of the functions have different parameters now, flat out don't exist, etc.

I've been putting in a lot more effort into documentation (code commenting) in my recent developments, so this should be mitigated some.