Closed (won't fix)
Project:
Drupal core
Version:
7.x-dev
Component:
documentation
Priority:
Normal
Category:
Bug report
Assigned:
Unassigned
Reporter:
Created:
10 Feb 2008 at 18:47 UTC
Updated:
3 Dec 2010 at 00:17 UTC
follow-up to 4 PHPDoc fixes, ironing out more warnings:
* @defgroup names should be single-word identifier, ie. [a-zA-Z_][a-zA-Z0-9_]* . no hyphens and dots.
* to group related functions in a file, use 'member groups' (@name header), not 'modules' (@defgroup|ingroup|addtogroup). latter work at a global level, creating a new page for each group - which isn't what you want for your 3 related module functions.
* a @defgroup can be defined only once (it can be added to with @addtogroup|ingroup).
* @file description must be on an extra line.
if anyone wants to help out fixing the Doxygen doc, just check the daily updated Doxygen error log of HEAD at http://drupal.kollm.org/ .
| Comment | File | Size | Author |
|---|---|---|---|
| doxygen.patch | 8.48 KB | ax |
Comments
Comment #1
jhodgdonI'm reviewing patches today... I cannot get this patch to apply to the current D6 code base (the patch is more than a year old).
Comment #2
jhodgdonAlso, if this is a problem also in Drupal 7, it should be patched there first and then ported back to Drupal 6.
Comment #3
jhodgdonAnyone want to make a new patch, preferably in Drupal 7, to fix the errors noted in the original report?
Comment #4
jhodgdonThe groups were cleaned up in Drupal 7, and some of the stuff in this report wasn't valid, so I'm going to close this as a "won't fix".