Document field types specifics (settings, columns...)

yched - May 16, 2009 - 16:15
Project:Drupal
Version:7.x-dev
Component:field system
Category:task
Priority:normal
Assigned:Unassigned
Status:active
Description

Each field type should provide an exhaustive description of
- their columns and indexes (when #415044: Indexes for field storage. gets in)
- their additional behavior on hook_field_load() (additional 'columns', filtering of invalid references...)
- their field and instance settings

Each formatter and widget should provide an exhaustive description of
- their settings
- for widgets, their '#properties' (when #362058: Field Types: Make widget FAPI elements field agnostic. gets in)

Ideally, those informations should not be scattered in various PHPdocs, but gathered at the beginning of each field-type module. Not sure about the exact format and structure, proposals welcome :-)

#1

bangpound - July 9, 2009 - 15:44

I will be posting the documentation for taxonomy term field's settings here, right? Then we can decide what structure and format is appropriate by making an object of my patch, ripping it apart and reassembling it.

 
 

Drupal is a registered trademark of Dries Buytaert.