BOINC / boinc

drupal/sites/default/boinc/modules/contrib/views/includes/view.inc

Doc Comments +16 added lines, -6 removed lines

@@ -409,7 +409,7 @@ 
   /**
    * Attach all of the handlers for each type.
    *
-   * @param $key
+   * @param string $key
    *   One of 'argument', 'field', 'sort', 'filter', 'relationship'
    * @param $info
    *   The $info from views_object_types for this object.
@@ -715,6 +715,7 @@ 
 
   /**
    * Internal method to build an individual set of handlers.
+   * @param string $key
    */
   function _build($key) {
     $handlers = &$this->$key;
@@ -1214,6 +1215,7 @@ 
 
   /**
    * Get the base path used for this view.
+   * @return string
    */
   function get_path() {
     if (!empty($this->override_path)) {
@@ -1467,6 +1469,7 @@ 
   /**
    * Save a row to the database for the given key, which is one of the
    * keys from view::db_objects()
+   * @param string $key
    */
   function _save_rows($key) {
     $count = 0;
@@ -1719,7 +1722,7 @@ 
   /**
    * Write the row to the database.
    *
-   * @param $update
+   * @param string|false $update
    *   If true this will be an UPDATE query. Otherwise it will be an INSERT.
    */
   function save_row($update = NULL) {
@@ -1802,7 +1805,7 @@ 
   /**
    * Export a loaded row, such as an argument, field or the view itself to PHP code.
    *
-   * @param $identifier
+   * @param string $identifier
    *   The variable to assign the PHP code for this object to.
    * @param $indent
    *   An optional indentation for prettifying nested code.
@@ -1888,7 +1891,7 @@ 
   /**
    * Generate a display id of a certain plugin type.
    *
-   * @param $type
+   * @param string $type
    *   Which plugin should be used for the new display id.
    */
   function generate_display_id($type) {
@@ -1914,9 +1917,9 @@ 
    * Create a new display and a display handler for it.
    * @param $type
    *   The plugin type from the views plugin data. Defaults to 'page'.
-   * @param $title
+   * @param string $title
    *   The title of the display; optional, may be filled in from default.
-   * @param $id
+   * @param string $id
    *   The id to use.
    * @return
    *   A reference to the new handler object.
@@ -1948,6 +1951,9 @@ 
    * Add an item with a handler to the view.
    *
    * These items may be fields, filters, sort criteria, or arguments.
+   * @param string $type
+   * @param string $table
+   * @param string $field
    */
   function add_item($display_id, $type, $table, $field, $options = array(), $id = NULL) {
     $types = views_object_types();
@@ -1979,6 +1985,7 @@ 
 
   /**
    * Get an array of items for the current display.
+   * @param string $type
    */
   function get_items($type, $display_id = NULL) {
     $this->set_display($display_id);
@@ -2059,6 +2066,9 @@ 
     parent::init($init);
   }
 
+  /**
+   * @param string $type
+   */
   function options($type, $id, $title) {
     $this->display_plugin = $type;
     $this->id = $id;

drupal/sites/default/boinc/modules/contrib/views/modules/comment/views_handler_field_node_new_comments.inc

Doc Comments +3 added lines

@@ -75,6 +75,9 @@
     }
   }
 
+  /**
+   * @param string $data
+   */
   function render_link($data, $values) {
     if (!empty($this->options['link_to_comment']) && $data !== NULL && $data !== '') {
       $node = new stdClass();

drupal/sites/default/boinc/modules/contrib/views/plugins/views_plugin_access.inc

Doc Comments +1 added lines, -1 removed lines

@@ -69,7 +69,7 @@
    * performance hits during menu item access testing, which happens
    * a lot.
    *
-   * @return an array; the first item should be the function to call,
+   * @return boolean array; the first item should be the function to call,
    *   and the second item should be an array of arguments. The first
    *   item may also be TRUE (bool only) which will indicate no
    *   access control.)

drupal/sites/default/boinc/modules/contrib/views/plugins/views_plugin_display.inc

Doc Comments +4 added lines, -1 removed lines

@@ -467,7 +467,7 @@ 
    * current display
    *
    * @return
-   *   TRUE for the default display
+   boolean   TRUE for the default display
    */
   function is_defaulted($option) {
     return !$this->is_default_display() && !empty($this->default_display) && !empty($this->options['defaults'][$option]);
@@ -645,6 +645,7 @@ 
   /**
    * Because forms may be split up into sections, this provides
    * an easy URL to exactly the right section. Don't override this.
+   * @param string $section
    */
   function option_link($text, $section, $class = '', $title = '') {
     if (!empty($class)) {
@@ -1703,6 +1704,7 @@ 
 
   /**
    * Flip the override setting for the given section.
+   * @param boolean $new_state
    */
   function set_override($section, $new_state = NULL) {
     $options = $this->defaultable_sections($section);
@@ -1767,6 +1769,7 @@ 
 
   /**
    * Render a text area, using the proper format.
+   * @param string $area
    */
   function render_textarea($area) {
     static $formats = array();

drupal/sites/default/boinc/modules/contrib/views/plugins/views_plugin_display_block.inc

Doc Comments +1 added lines

@@ -183,6 +183,7 @@
   /**
    * Save the block cache setting in the blocks table if this block allready
    * exists in the blocks table. Dirty fix untill http://drupal.org/node/235673 gets in.
+   * @param string $delta
    */
   function save_block_cache($delta, $cache_setting) {
     if ($bid = db_fetch_object(db_query("SELECT bid, cache FROM {blocks} WHERE module = 'views' AND delta = '%s'", $delta))) {

drupal/sites/default/boinc/modules/contrib/views/plugins/views_plugin_style.inc

Doc Comments +1 added lines

@@ -231,6 +231,7 @@
    *   The index count of the row.
    * @param $field
    *    The id of the field.
+   * @return string
    */
   function get_field($index, $field) {
     if (!isset($this->rendered_fields)) {

drupal/sites/default/boinc/modules/contrib/views/views.module

Doc Comments +7 added lines

@@ -510,6 +510,7 @@ 
 /**
  * Set the current 'page view' that is being displayed so that it is easy
  * for other modules or the theme to identify.
+ * @param views_plugin_display_page $view
  */
 function &views_set_page_view($view = NULL) {
   static $cache = NULL;
@@ -556,6 +557,7 @@ 
 
 /**
  * Include views .inc files as necessary.
+ * @param string $file
  */
 function views_include($file) {
   static $used = array();
@@ -568,6 +570,7 @@ 
 
 /**
  * Load views files on behalf of modules.
+ * @param string $file
  */
 function views_module_include($file) {
   foreach (views_get_module_apis() as $module => $info) {
@@ -601,6 +604,7 @@ 
 
 /**
  * Include views .css files.
+ * @param string $file
  */
 function views_add_css($file) {
   // We set preprocess to FALSE because we are adding the files conditionally,
@@ -612,6 +616,7 @@ 
 
 /**
  * Include views .js files.
+ * @param string $file
  */
 function views_add_js($file) {
   // If javascript has been disabled by the user, never add js files.
@@ -722,6 +727,7 @@ 
 /**
  * Get a handler for a plugin
  *
+ * @param string $type
  * @return views_plugin
  *
  * The created plugin object.
@@ -807,6 +813,7 @@ 
  *   array($view, $display_id),
  * );
  * @endcode
+ * @param string $type
  */
 function views_get_applicable_views($type) {
   // @todo: Use a smarter flagging system so that we don't have to

drupal/sites/default/boinc/modules/contrib/cck/content.module

Doc Comments +15 added lines, -10 removed lines

@@ -1234,6 +1234,8 @@ 
  *
  * For each operation, both this function and _content_field_invoke_default() are
  * called so that the default database handling can occur.
+ * @param string $op
+ * @param boolean $page
  */
 function _content_field_invoke($op, &$node, $teaser = NULL, $page = NULL) {
   $type_name = is_string($node) ? $node : (is_array($node) ? $node['type'] : $node->type);
@@ -1268,6 +1270,8 @@ 
 
 /**
  * Invoke content.module's version of a field hook.
+ * @param string $op
+ * @param boolean $page
  */
 function _content_field_invoke_default($op, &$node, $teaser = NULL, $page = NULL) {
   $type_name = is_string($node) ? $node : (is_array($node) ? $node['type'] : $node->type);
@@ -1746,6 +1750,7 @@ 
  * Used for items entered by administrators, like field descriptions,
  * allowed values, where some (mainly inline) mark-up may be desired
  * (so check_plain() is not acceptable).
+ * @return string
  */
 function content_filter_xss($string) {
   return filter_xss($string, _content_filter_xss_allowed_tags());
@@ -1975,7 +1980,7 @@ 
  *
  * @param $name
  *   The name of the content type or content field
- * @param $storage
+ * @param integer $storage
  *   CONTENT_DB_STORAGE_PER_FIELD or CONTENT_DB_STORAGE_PER_CONTENT_TYPE
  * @return
  *   A string containing the generated name for the database table
@@ -2109,7 +2114,7 @@ 
  * @param $name
  *   Name of the index.
  * @return
- *   TRUE if the table exists. Otherwise FALSE.
+ boolean   TRUE if the table exists. Otherwise FALSE.
  */
 function content_db_index_exists($table, $name) {
   global $db_type;
@@ -2139,9 +2144,9 @@ 
  *  with respect to a given operation. (currently used for field 'view',
  *  and widget 'default values' and 'multiple values')
  *
- *  @param $entity
+ *  @param string $entity
  *    'field' or 'widget'
- *  @param $op
+ *  @param string $op
  *    the name of the operation ('view', 'default value'...)
  *  @param $field
  *    The field array, including widget info.
@@ -2169,9 +2174,9 @@ 
  *
  *  Currently used for widgets and formatters 'multiple values'.
  *
- *  @param $entity
+ *  @param string $entity
  *    'field', 'widget' or 'formatter'
- *  @param $op
+ *  @param string $op
  *    the name of the operation ('default values'...)
  *  @param $object
  *    - if $entity is 'field' or 'widget': the field array,
@@ -2232,7 +2237,7 @@ 
 /**
  * Determine whether the user has access to a given field.
  *
- * @param $op
+ * @param string $op
  *   The operation to be performed. Possible values:
  *   - "edit"
  *   - "view"
@@ -2243,7 +2248,7 @@ 
  * @param $node
  *   (optional) The node on which the operation is to be performed.
  * @return
- *   TRUE if the operation is allowed;
+ boolean   TRUE if the operation is allowed;
  *   FALSE if the operation is denied.
  */
 function content_access($op, $field, $account = NULL, $node = NULL) {
@@ -2324,7 +2329,7 @@ 
  *      hook_content_build_modes().
  *
  * @return
- *   Whether or not content is to be added to $content in this context.
+ boolean   Whether or not content is to be added to $content in this context.
  *   Uses the value of the 'Exclude' checkbox for this field
  *   as set on the Manage fields screen.
  */
@@ -2572,7 +2577,7 @@ 
  *
  * @param $type_name
  *   The content type name.
- * @param $pseudo_field_name
+ * @param string $pseudo_field_name
  *   The name of the 'field'.
  * @return
  *   The weight for the 'field', respecting the user settings stored

drupal/sites/default/boinc/modules/contrib/flag/flag.inc

Doc Comments +6 added lines, -5 removed lines

@@ -430,7 +430,7 @@ 
    *   Optional. The user object. If none given, the current user will be used.
    *
    * @return
-   *   Boolean TRUE if the user is allowed to flag/unflag. FALSE otherwise.
+   boolean   Boolean TRUE if the user is allowed to flag/unflag. FALSE otherwise.
    */
   function user_access($action = 'flag', $account = NULL) {
     if (!isset($account)) {
@@ -620,7 +620,7 @@ 
    * @param $skip_permission_check
    *   Flag the item even if the $account user don't have permission to do so.
    * @return
-   *   FALSE if some error occured (e.g., user has no permission, flag isn't
+   boolean   FALSE if some error occured (e.g., user has no permission, flag isn't
    *   applicable to the item, etc.), TRUE otherwise.
    */
   function flag($action, $content_id, $account = NULL, $skip_permission_check = FALSE) {
@@ -702,7 +702,7 @@ 
    *   current user will be used.
    *
    * @return
-   *   TRUE if the content is flagged, FALSE otherwise.
+   boolean   TRUE if the content is flagged, FALSE otherwise.
    */
   function is_flagged($content_id, $uid = NULL, $sid = NULL) {
     return (bool) $this->get_flagging_record($content_id, $uid, $sid);
@@ -875,7 +875,7 @@ 
    * E.g., do `print $flag->get_label('title')` instead of `print
    * $flag->title`.
    *
-   * @param $label
+   * @param string $label
    *   The label to get, e.g. 'title', 'flag_short', 'unflag_short', etc.
    * @param $content_id
    *   The ID in whose context to interpret tokens. If not given, only global
@@ -1147,7 +1147,7 @@ 
    * call flag_get_flag($this->name) again.
    *
    * @return
-   *   TRUE if the flag was reverted successfully; FALSE if there was an error;
+   boolean|null   TRUE if the flag was reverted successfully; FALSE if there was an error;
    *   NULL if this flag overrides no default flag.
    */
   function revert() {
@@ -1787,6 +1787,7 @@ 
 
   /**
    * Returns the actual storage object compatible with the flag.
+   * @param flag_flag $flag
    */
   static function factory($flag) {
     if ($flag->global) {