diff options
| author | Steve Clay <steve@mrclay.org> | 2013-02-04 20:37:25 -0500 |
|---|---|---|
| committer | Cash Costello <cash.costello@gmail.com> | 2013-02-09 07:47:28 -0500 |
| commit | 85e4c16f39a8b00b229644bcd175663541dfd51a (patch) | |
| tree | 49a503ec7eebe24f19025fe5ac0c890857cf86cf /engine/lib/annotations.php | |
| parent | 2cd87bb4ecf6df7b3aea9189cf1933ac3a78038c (diff) | |
| download | elgg-85e4c16f39a8b00b229644bcd175663541dfd51a.tar.gz elgg-85e4c16f39a8b00b229644bcd175663541dfd51a.tar.bz2 | |
Doc fixes and inline type hints for variables (big static analysis cleanup)
Diffstat (limited to 'engine/lib/annotations.php')
| -rw-r--r-- | engine/lib/annotations.php | 11 |
1 files changed, 9 insertions, 2 deletions
diff --git a/engine/lib/annotations.php b/engine/lib/annotations.php index 3b9f84703..9ba0491b2 100644 --- a/engine/lib/annotations.php +++ b/engine/lib/annotations.php @@ -30,7 +30,7 @@ function row_to_elggannotation($row) { * * @param int $id The id of the annotation object being retrieved. * - * @return false|ElggAnnotation + * @return ElggAnnotation|false */ function elgg_get_annotation_from_id($id) { return elgg_get_metastring_based_object_from_id($id, 'annotations'); @@ -195,7 +195,7 @@ function update_annotation($annotation_id, $name, $value, $value_type, $owner_gu * for the proper use of the "calculation" option. * * - * @return mixed + * @return ElggAnnotation[]|mixed * @since 1.8.0 */ function elgg_get_annotations(array $options = array()) { @@ -451,6 +451,7 @@ function elgg_list_entities_from_annotation_calculation($options) { * @elgg_plugin_hook export all * * @return mixed + * @throws InvalidParameterException * @access private */ function export_annotation_plugin_hook($hook, $entity_type, $returnvalue, $params) { @@ -557,6 +558,12 @@ function elgg_register_annotation_url_handler($extender_name = "all", $function_ /** * Register annotation unit tests + * + * @param string $hook + * @param string $type + * @param array $value + * @param array $params + * @return array * @access private */ function annotations_test($hook, $type, $value, $params) { |