This task is to ensure that all functions, classes, methods, and constants in the FAQ and Avatar Selection modules have properly formed, complete Doxygen code comments.
Doxygen is the documentation generation system that Drupal uses. The documentation is extracted directly from the sources, which makes it much easier to keep the documentation consistent with the source code. The documentation should contain information that is helpful to developers who may not be familiar with the code, such as explaining what functions do, how functions should be called and what information the different parameters contain. Developers often need need to check the API documentation when creating patches or developing new features and so it is important to have clear, correct documentation.
To complete this task, review the two modules and add API documentation to any function, class, method, or constant that does not have it or expand on existing documentation where it is incomplete, unclear, or does not follow established Drupal standards. See the resources section for more information, particularly the "Drupal Doxygen formatting conventions".
The final deliverable will be a set of 2 patches against the 6.x versions of the FAQ and Avatar Selection modules posted to the issue queue that has been reviewed and marked "Ready to be Committed".
- Drupal Doxygen formatting conventions - http://drupal.org/node/1354
- Drupal Coding Standards - http://drupal.org/coding-standards
- FAQ project page - http://drupal.org/project/faq
- Avatar Selection project page - http://drupal.org/project/avatar_selection
Stella Power (http://drupal.org/user/66894 - snpower)