Field structure documentation is missing the description of the structured arrays and their keys (field.crud.inc lines 36-199).

CommentFileSizeAuthor
#2 field_structures_doc-996196.patch1.33 KByched

Comments

jhodgdon’s picture

This group is also completely empty. Needs to be investigated.

yched’s picture

Status: Active » Needs review
StatusFileSize
new1.33 KB

Just 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 :

/**
 * @defgroup field_structs Field API data structures
 * @{
 * Represent Field API fields and instances.
 *
 * The Field API defines two primary data structures, Field and
...
 * Field definitions are represented as an array of key/value pairs.
 *
 * @param array $field:
 * - id (integer, read-only)
 *     The primary identifier of the field. It is assigned automatically
 *     by field_create_field().

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.

jhodgdon’s picture

Title: Documentation problem with Field API data structures » Field API data structures group/topic contains wrong doxygen tags
Status: Needs review » Needs work

Right, @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. :)

mile23’s picture

This 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....)

jhodgdon’s picture

Status: Needs work » Fixed

Yes, sorry, there was another issue that took care of cleaning up the Field API topics/groups.

Status: Fixed » Closed (fixed)

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