The task is review the status of doxygen navigation and links between api.drupal.org and 'examples for developers' module, and provide results about the efectivity of the integration between these two documentation components.

An student with Drupal programing knowledge is prefered.

Preparation and task list

  • Get a copy of Drupal and "examples for developers" module and install them.
  • Go through each one of the examples module and perform the following review
    • Verify that component is discoverable from api.drupal.org
    • Verify that component's doxygen documentation is browseable.

Deliverables

The student should fill an issue in the issue queue for each 'examples for developers' component with the following conditions:

  • An abstract about the understanding and browseable status of the module component
  • Detail what was found wrong and not browseable
  • Detail differences between API documentation and module documentation if found
  • A patch to fix the doxygen documentation

Resources

http://code.google.com/p/google-highly-open-participation-drupal/wiki/Fu...

Examples project at drupal.org: http://drupal.org/project/examples
Drupal API site: http://api.drupal.org/api/7
Doxygen formatting conventions: http://drupal.org/node/1354
How to work with patches: http://drupal.org/patch/create
Drupal coding standards: http://drupal.org/coding-standards

Primary Contact

Charlie Gordon, ( cwgordon7 on irc or http://drupal.org/user/157412/contact form)

Could mentor: ilo

Comments

ilo’s picture

ilo commented
Status: Active » Needs review

I forgot to set as NR.

vosechu’s picture

vosechu commented

I thought api.d.o was built using the doxygen comments, is it possible that these have gotten out of sync or are you talking about integrating the comments into doxygen?

cwgordon7’s picture

cwgordon7 commented
Status: Needs review » Needs work

Yeah, I'm not sure what you're talking about - can you please clarify and address comment #2? Thanks!

dawehner’s picture

dawehner
Primary language German
commented 

The task is review the status of doxygen navigation and links between api.drupal.org and 'examples for developers' module, and provide results about the efectivity of the integration between these two documentation components.

api.drupal.org uses the examples module currently. So there is no need to check the difference?