#920600 by bojanz, solotandem: Fixed Document the deprecated parameter in entity_load()

1 files changed, 12 insertions, 3 deletions

diff --git a/modules/comment/comment.module b/modules/comment/comment.module
index 2e9b86ade..f5d9f0f5e 100644
--- a/modules/comment/comment.module
+++ b/modules/comment/comment.module
@@ -1623,10 +1623,19 @@ function comment_delete_multiple($cids) {
  * @param $cids
  *   An array of comment IDs.
  * @param $conditions
- *   An array of conditions to match against the {comments} table. These
- *   should be supplied in the form array('field_name' => 'field_value').
+ *   (deprecated) An associative array of conditions on the {comments}
+ *   table, where the keys are the database fields and the values are the
+ *   values those fields must have. Instead, it is preferable to use
+ *   EntityFieldQuery to retrieve a list of entity IDs loadable by
+ *   this function.
+ *
  * @return
- *  An array of comment objects, indexed by comment ID.
+ *   An array of comment objects, indexed by comment ID.
+ *
+ * @see entity_load()
+ * @see EntityFieldQuery
+ *
+ * @todo Remove $conditions in Drupal 8.
  */
 function comment_load_multiple($cids = array(), $conditions = array()) {
   return entity_load('comment', $cids, $conditions);