Closed (fixed)
Project:
Drupal core
Version:
7.x-dev
Component:
documentation
Priority:
Normal
Category:
Bug report
Assigned:
Unassigned
Reporter:
Created:
12 Dec 2010 at 16:57 UTC
Updated:
4 Mar 2011 at 02:11 UTC
Jump to comment: Most recent file
Comments
Comment #1
jhodgdonThis group is also completely empty. Needs to be investigated.
Comment #2
yched commentedJust noted the same thing in #995708: Doc formatting : Field API structures missing on a.d.o (marked as dupe)
The PHPdoc in field.crud.inc reads :
The part after @param is cut off, @param is most probably not the correct tag to use here.
Would @code be better ?
(note that this describes a nested structure, so preserving indentation is required for understandability.
Comment #3
jhodgdonRight, @param is only recognized by the API module (which builds api.drupal.org) for functions, not for group/topic declarations, which is what this is.
We actually don't need/want @code here either. Just use - to designate list items, and they'll be turned into a bullet list on the API site. There's information on list formatting at
http://drupal.org/node/1354#lists
Bonus points if you go through the documentation block and make sure the whole thing reads well and conforms to our guidelines. :)
Comment #4
mile23This seems to have already happened. The field_structs group seems to have been changed to the field_crud group and the struct info moved to field group. Closed?
(I was hoping for those bonus points, too....)
Comment #5
jhodgdonYes, sorry, there was another issue that took care of cleaning up the Field API topics/groups.