summaryrefslogtreecommitdiff
path: root/modules/field_ui
diff options
context:
space:
mode:
authorDries Buytaert <dries@buytaert.net>2010-11-07 21:53:11 +0000
committerDries Buytaert <dries@buytaert.net>2010-11-07 21:53:11 +0000
commit1e03b87733bbb0b69052742b7a47255245224a5b (patch)
treec8761d050f2752027bf371c650ab256604afa46e /modules/field_ui
parent9f64d0e46c09258ea561586a59e5e8b521452aa3 (diff)
downloadbrdo-1e03b87733bbb0b69052742b7a47255245224a5b.tar.gz
brdo-1e03b87733bbb0b69052742b7a47255245224a5b.tar.bz2
- Patch #961412 by yched, andypost: improved documentation of formatter settings.
Diffstat (limited to 'modules/field_ui')
-rw-r--r--modules/field_ui/field_ui.api.php4
1 files changed, 4 insertions, 0 deletions
diff --git a/modules/field_ui/field_ui.api.php b/modules/field_ui/field_ui.api.php
index 0db4c01d3..0e031ba2f 100644
--- a/modules/field_ui/field_ui.api.php
+++ b/modules/field_ui/field_ui.api.php
@@ -173,6 +173,10 @@ function hook_field_formatter_settings_form($field, $instance, $view_mode, $form
/**
* Returns a short summary for the current formatter settings of an instance.
*
+ * If an empty result is returned, the formatter is asuumed to have no
+ * configurable settings, and no UI will be provided to display a settings
+ * form.
+ *
* @param $field
* The field structure.
* @param $instance