This is a community-driven attempt to create a documentation of the andengine code.

This project moved to github

Since the repository of andengine moved to github, this project also moved to github: Maarten took the first step in setting up everything and the new project's home is waiting for your contribution. All future work will happen there, this project here won't get updated anymore. You are encourage to participate on github.

Usage

To use documentation you can check-out everything to your local machine and open up index.html in your browser. If you are using andengine by referencing the .jar you can also set the Javadoc location path in Eclipse to http://andengine-doc.googlecode.com/hg/ . Or just point your browser to the latest documentation in the repository.

There is also the commented code in the repository available. You might prefer to work with it. Or if you like to help documenting you can use this as a base to work on (you can use it as a reference in your project and just add comments as you like and push your changes from time to time). Mind that the code might not be as update-to-date as from the original project hosting.

Suggestions

If you have any suggestions, questions or need help, just create a new ticket ... actually, you might want to take a look first if somebody else had a similar concern.

Wanted

Currently, this is still a one man small group show -- we still need more people! It would be great if a handful of people would volunteer to participate in contributing some documentation. There is no need to take over huge load of work -- everybody can contribute as little or much as possible. If it's just a two lines class comment, a typo correction in existing comments or a whole documentation of a package: every contribution is appreciated!

Everybody who wants to help with the documentation is welcome! Just fill in your email and you will be added as a contributor. You can also create a clone and work on the documentation (and request to pull your changes in a ticket)

Before you get started, you might want to read the guidelines on how to write comments. If you need help with the repository, the FAQs might help you.