add comments to explain the format for the options.

leocornus · Jan 16, 2014 · 26deeab · 26deeab
1 parent 427fdf4
commit 26deeab
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/wp-trac-client/widgets/utils.php b/wp-trac-client/widgets/utils.php
@@ -45,6 +45,12 @@ function wptc_widget_parse_content($wiki) {
  * preparing the options for select tag.
  * this could be used by type, milestone, version,
  * priority dropdown
+ * Options will an array with the following format:
+ *
+ * $options = array(
+ *     'options_value_1' => 'options_label_1',
+ *     'options_value_2' => 'options_label_2'
+ * );
  */
 function wptc_widget_options_html($options, $selected="", 
                                   $hasEmpty=true,