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:
contextual_links_example- #2004114: entity_example: @defgroup doxygen for api.drupal.org
- #2004120: pager_example: @defgroup doxygen for api.drupal.org
rdf_example- #2004288: tablesort_example and tabledrag_example: @defgroup doxygen for api.drupal.org
theming_example
The Process:
- Check out the Examples project using git.
- Pick a module from the list above.
- Work on adding doxy formatting to it, especially @defgroup markers.
- Create an issue with a name like 'Doxygen formatting for some_example'
- Submit your patch on the issue you just created. (Be sure and set the status to 'needs review,' so the automated testing will happen.)
- Add a comment to this issue, linking to your issue.
Thanks, folks. :-)
| Comment | File | Size | Author |
|---|---|---|---|
| #2 | 1984316-examples-doxy.patch | 9.02 KB | mile23 |
Comments
Comment #1
mile23See also: #1100190: Improve doxygen formatting of .test files
Comment #1.0
mile23Added link to git checkout
Comment #1.1
mile23Updated issue summary.
Comment #1.2
mile23added pager_example
Comment #2
mile23Patch for the remainders: contextual link, rdf, and theming.
Comment #3
mile23And.... Committed.
http://drupalcode.org/project/examples.git/commitdiff/70fe60a44c982cc2c1...
Comment #3.0
mile23Updated issue summary.
Comment #4.0
(not verified) commentedUpdated issue summary.