Changeset 10163 for trunk/src/bp-xprofile/classes/class-bp-xprofile-field-type-textbox.php

Timestamp:

10/01/2015 04:18:13 AM (11 years ago)

Author:

tw2113

Message:

First pass of documentation cleanup for the XProfile Component.

See #6406.

File:

• trunk/src/bp-xprofile/classes/class-bp-xprofile-field-type-textbox.php (modified) (5 diffs)

trunk/src/bp-xprofile/classes/class-bp-xprofile-field-type-textbox.php

@@ -1 +1 @@
 <?php
 /**
- * BuddyPress XProfile Classes
+ * BuddyPress XProfile Classes.
  *
  * @package BuddyPress
@@ -18 +18 @@
 
         /**
-         * Constructor for the textbox field type
+         * Constructor for the textbox field type.
          *
          * @since 2.0.0
-         */
+         */
         public function __construct() {
                 parent::__construct();
@@ -43 +43 @@
         /**
          * Output the edit field HTML for this field type.
-         *
          * Must be used inside the {@link bp_profile_fields()} template loop.
          *
-         * @param array $raw_properties Optional key/value array of {@link http://dev.w3.org/html5/markup/input.text.html permitted attributes} that you want to add.
          * @since 2.0.0
+         *
+         * @param array $raw_properties Optional key/value array of
+         *                              {@link http://dev.w3.org/html5/markup/input.text.html permitted attributes}
+         *                              that you want to add.
          */
         public function edit_field_html( array $raw_properties = array() ) {
 
-                // user_id is a special optional parameter that certain other fields
+                // User_id is a special optional parameter that certain other fields
                 // types pass to {@link bp_the_profile_field_options()}.
                 if ( isset( $raw_properties['user_id'] ) ) {
@@ -84 +86 @@
          * Must be used inside the {@link bp_profile_fields()} template loop.
          *
+         * @since 2.0.0
+         *
          * @param array $raw_properties Optional key/value array of permitted attributes that you want to add.
-         * @since 2.0.0
          */
         public function admin_field_html( array $raw_properties = array() ) {
@@ -102 +105 @@
          * "Add Field" and "Edit Field" screens, but for this field type, we don't want it, so it's stubbed out.
          *
+         * @since 2.0.0
+         *
          * @param BP_XProfile_Field $current_field The current profile field on the add/edit screen.
-         * @param string $control_type Optional. HTML input type used to render the current field's child options.
-         * @since 2.0.0
+         * @param string            $control_type  Optional. HTML input type used to render the
+         *                                         current field's child options.
          */
         public function admin_new_field_html( BP_XProfile_Field $current_field, $control_type = '' ) {}