API Documentation

[krisives]

This thread was started as a request for documentation and grew into a project to document Compiz. Doxygen generated documentation can be found here:

http://docs.compiz.org/annotated.html

Anyone wanting to get involved with documenting should join the IRC Channel (irc.freenode.net #compiz-dev) and post in this thread. We had a vote (done now) and chose to use /** instead of ///. You may see the old /// around, and if so, please update it.

If you see a class or method that isn't documented that should be, create a /** TODO */ element so it shows up in the API documentation so others know it needs to be done and that the class/method is part of the API.

Update: iXce got this integrated with git, so it happens as a post-commit on the master branch! So these API docs will update as Compiz continues to get more documentation.

[SmSpillaz]

wiki.compiz.org/Development

[krisives]

I've got some doxygen up here: http://santiance.com/doc/compiz/html/

[krisives]

I've been bugging folks on IRC for almost a week now with fuzzy results. What's the plan to get the docs moved to compiz.org?

1. Who has control over this?
2. Do they have time? If not, maybe someone else should do it

How will we go about merging this into master? My branch that I checked out from 0.9 master (http://cgit.compiz.org/~krisives/compiz-core-doc/) is getting out-of-date and the entire time I've been asking about merging as to avoid the obvious headaches it will cause in the future. Basically I'm going to be rather irritated when I do merge and I have to resolve endless conflicts that should have been avoided.

Cheers,
Kris

[krisives]

I've updated this post, as this is now integrated with the git as a post-commit, so anyone working on Compiz can document a class, method, etc. Read the top message for details.