This is round 2 of this older issue: #767204: API.drupal.org: Rework Doxygen comments so people can navigate the comments

We need to get the docblocks in line for inclusion in api.drupal.org. Many of the newer modules lack some important markup and have been skipped by api's parser, so let's add it.

rfay gives a good rundown of the documentation standards and docblock process here: http://drupal.org/node/767204#comment-2836190 though some of the links don't work.

We don't need a lot of editorial decisions at this point, mainly just good markup with @defgroup tags.

Here's a list of the modules that lack proper doxygen comments:

The Process:

  1. Check out the Examples project using git.
  2. Pick a module from the list above.
  3. Work on adding doxy formatting to it, especially @defgroup markers.
  4. Create an issue with a name like 'Doxygen formatting for some_example'
  5. Submit your patch on the issue you just created. (Be sure and set the status to 'needs review,' so the automated testing will happen.)
  6. Add a comment to this issue, linking to your issue.

Thanks, folks. :-)

CommentFileSizeAuthor
#2 1984316-examples-doxy.patch9.02 KBmile23

Comments

mile23’s picture

mile23’s picture

Issue summary: View changes

Added link to git checkout

mile23’s picture

Issue summary: View changes

Updated issue summary.

mile23’s picture

Issue summary: View changes

added pager_example

mile23’s picture

Status: Active » Needs review
StatusFileSize
new9.02 KB

Patch for the remainders: contextual link, rdf, and theming.

mile23’s picture

Status: Needs review » Fixed
mile23’s picture

Issue summary: View changes

Updated issue summary.

Automatically closed -- issue fixed for 2 weeks with no activity.

Anonymous’s picture

Issue summary: View changes

Updated issue summary.