Changeset 5148

Timestamp:

09/14/2011 01:34:34 PM (13 years ago)

Author:

boonebgorges

Message:

Corrects some PHPDoc for BP_Component

File:

• trunk/bp-core/bp-core-component.php (modified) (2 diffs)

trunk/bp-core/bp-core-component.php

@@ -41 +41 @@
 
     /**
-     * @var string The path to the plugins files
+     * @var string The path to the component's files
      */
     var $path;
@@ -71 +71 @@
      *
      * @param mixed $args Required. Supports these args:
-     *  - name: Unique name (for internal identification)
-     *  - id: Unique ID (normally for custom post type)
-     *  - slug: Unique slug (used in query string and permalinks)
-     *  - query: The loop for this component (WP_Query)
-     *  - current_id: The current ID of the queried object
-     * @uses bp_Component::setup_globals() Setup the globals needed
-     * @uses bp_Component::includes() Include the required files
+     *  - id: Unique ID (for internal identification). Letters, numbers, and underscores only
+     *  - name: Unique name. This should be a translatable name, eg __( 'Groups', 'buddypress' )
+     *  - path: The file path for the component's files. Used by BP_Component::includes()
      * @uses bp_Component::setup_actions() Setup the hooks and actions
      */