aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorcash <cash@36083f99-b078-4883-b0ff-0f9b5a30f544>2011-02-06 20:04:57 +0000
committercash <cash@36083f99-b078-4883-b0ff-0f9b5a30f544>2011-02-06 20:04:57 +0000
commit125dcdd329b3159808c097f02597e908be3ad8d0 (patch)
tree653b77aa409f867be32c45793edc68b099e15c69
parent61197684ae861488cd3718fcaa96ab655b37e426 (diff)
downloadelgg-125dcdd329b3159808c097f02597e908be3ad8d0.tar.gz
elgg-125dcdd329b3159808c097f02597e908be3ad8d0.tar.bz2
fixed some minor documentation issues
git-svn-id: http://code.elgg.org/elgg/trunk@8050 36083f99-b078-4883-b0ff-0f9b5a30f544
-rw-r--r--engine/classes/ElggUser.php4
-rw-r--r--engine/lib/actions.php4
-rw-r--r--engine/lib/database.php2
-rw-r--r--engine/lib/deprecated-1.7.php2
-rw-r--r--engine/lib/elgglib.php12
-rw-r--r--engine/lib/entities.php6
-rw-r--r--engine/lib/relationships.php4
-rw-r--r--engine/lib/widgets.php2
8 files changed, 18 insertions, 18 deletions
diff --git a/engine/classes/ElggUser.php b/engine/classes/ElggUser.php
index ff449d601..333792513 100644
--- a/engine/classes/ElggUser.php
+++ b/engine/classes/ElggUser.php
@@ -536,7 +536,7 @@ class ElggUser extends ElggEntity
*/
public function __set($name, $value) {
if ($name == 'admin' || $name == 'siteadmin') {
- elgg_deprecated_notice('The admin/siteadmin metadata are not longer used. Use ElggUser->makeAdmin() and ElggUser->removeAdmin().', '1.7.1');
+ elgg_deprecated_notice('The admin/siteadmin metadata are not longer used. Use ElggUser->makeAdmin() and ElggUser->removeAdmin().', 1.7);
if ($value == 'yes' || $value == '1') {
$this->makeAdmin();
@@ -556,7 +556,7 @@ class ElggUser extends ElggEntity
*/
public function __get($name) {
if ($name == 'admin' || $name == 'siteadmin') {
- elgg_deprecated_notice('The admin/siteadmin metadata are not longer used. Use ElggUser->isAdmin().', '1.7.1');
+ elgg_deprecated_notice('The admin/siteadmin metadata are not longer used. Use ElggUser->isAdmin().', 1.7);
return $this->isAdmin();
}
diff --git a/engine/lib/actions.php b/engine/lib/actions.php
index 8d91820fd..a93617df9 100644
--- a/engine/lib/actions.php
+++ b/engine/lib/actions.php
@@ -342,8 +342,8 @@ function get_site_secret() {
*
* @param string $action Action name
*
- * @return BOOL
- * @since 1.8
+ * @return bool
+ * @since 1.8.0
*/
function elgg_action_exist($action) {
global $CONFIG;
diff --git a/engine/lib/database.php b/engine/lib/database.php
index 973e63e53..5f5380002 100644
--- a/engine/lib/database.php
+++ b/engine/lib/database.php
@@ -366,7 +366,7 @@ function get_data_row($query, $callback = "") {
*
* @return array An array of database result objects or callback function results. If the query
* returned nothing, an empty array.
- * @since 1.8
+ * @since 1.8.0
*/
function elgg_query_runner($query, $callback = null, $single = false) {
global $CONFIG, $DB_QUERY_CACHE;
diff --git a/engine/lib/deprecated-1.7.php b/engine/lib/deprecated-1.7.php
index 13a960d0b..9bc772f27 100644
--- a/engine/lib/deprecated-1.7.php
+++ b/engine/lib/deprecated-1.7.php
@@ -257,7 +257,7 @@ function get_library_files($directory, $exceptions = array(), $list = array()) {
*/
function elgg_validate_action_url($url) {
elgg_deprecated_notice('elgg_validate_action_url() deprecated by elgg_add_action_tokens_to_url().',
- '1.7b');
+ 1.7);
return elgg_add_action_tokens_to_url($url);
}
diff --git a/engine/lib/elgglib.php b/engine/lib/elgglib.php
index 66477785e..de2d9bcdd 100644
--- a/engine/lib/elgglib.php
+++ b/engine/lib/elgglib.php
@@ -761,7 +761,7 @@ function elgg_trigger_event($event, $object_type, $object = null) {
* @example hooks/register/basic.php Registering for a plugin hook and examining the variables.
* @example hooks/register/advanced.php Registering for a plugin hook and changing the params.
* @link http://docs.elgg.org/Tutorials/Plugins/Hooks
- * @since 1.8
+ * @since 1.8.0
*/
function elgg_register_plugin_hook_handler($hook, $type, $callback, $priority = 500) {
global $CONFIG;
@@ -802,7 +802,7 @@ function elgg_register_plugin_hook_handler($hook, $type, $callback, $priority =
* @param callback $callback The PHP callback to be removed
*
* @return void
- * @since 1.8
+ * @since 1.8.0
*/
function elgg_unregister_plugin_hook_handler($hook, $entity_type, $callback) {
global $CONFIG;
@@ -853,7 +853,7 @@ function elgg_unregister_plugin_hook_handler($hook, $entity_type, $callback) {
* @example hooks/basic.php Trigger and respond to a basic plugin hook.
* @link http://docs.elgg.org/Tutorials/Plugins/Hooks
*
- * @since 1.8
+ * @since 1.8.0
*/
function elgg_trigger_plugin_hook($hook, $type, $params = null, $returnvalue = null) {
global $CONFIG;
@@ -1330,7 +1330,7 @@ function elgg_http_add_url_query_elements($url, array $elements) {
* @param array $ignore_params GET params to ignore in the comparison
*
* @return BOOL
- * @since 1.8
+ * @since 1.8.0
*/
function elgg_http_url_is_identical($url1, $url2, $ignore_params = array('offset', 'limit')) {
global $CONFIG;
@@ -1554,7 +1554,7 @@ function elgg_set_active_sticky_form($form_name) {
* return $default if the array key is unset or empty.
*
* @return void
- * @since 1.8
+ * @since 1.8.0
*/
function elgg_get_array_value($key, array $array, $default = NULL, $strict = true) {
if ($strict) {
@@ -1806,7 +1806,7 @@ function elgg_walled_garden_index() {
* plugin pages by {@elgg_hook public_pages walled_garden} will redirect to
* a login page.
*
- * @since 1.8
+ * @since 1.8.0
* @elgg_event_handler init system
* @link http://docs.elgg.org/Tutorials/WalledGarden
* @return void
diff --git a/engine/lib/entities.php b/engine/lib/entities.php
index ac2679dfc..3ab53c678 100644
--- a/engine/lib/entities.php
+++ b/engine/lib/entities.php
@@ -1050,7 +1050,7 @@ function elgg_get_entity_type_subtype_where_sql($table, $types, $subtypes, $pair
* @param NULL|array $guids Array of GUIDs.
*
* @return false|str
- * @since 1.8
+ * @since 1.8.0
* @access private
*/
function elgg_get_guid_based_where_sql($column, $guids) {
@@ -2080,8 +2080,8 @@ function recursive_delete_permissions_check() {
* @param string $subtype Entity subtype
* @param string $class Class name
*
- * @return Bool
- * @since 1.8
+ * @return bool
+ * @since 1.8.0
*/
function elgg_instanceof($entity, $type = NULL, $subtype = NULL, $class = NULL) {
$return = ($entity instanceof ElggEntity);
diff --git a/engine/lib/relationships.php b/engine/lib/relationships.php
index 0774c655a..c032ff5b9 100644
--- a/engine/lib/relationships.php
+++ b/engine/lib/relationships.php
@@ -356,7 +356,7 @@ function elgg_list_entities_from_relationship(array $options = array()) {
* @param array $options An options array compatible with
* elgg_get_entities_from_relationship()
* @return array
- * @since 1.8
+ * @since 1.8.0
*/
function elgg_get_entities_from_relationship_count(array $options = array()) {
$options['selects'][] = "COUNT(e.guid) as total";
@@ -373,7 +373,7 @@ function elgg_get_entities_from_relationship_count(array $options = array()) {
* @param array $options Options array
*
* @return array
- * @since 1.8
+ * @since 1.8.0
*/
function elgg_list_entities_from_relationship_count($options) {
return elgg_list_entities($options, 'elgg_get_entities_from_relationship_count');
diff --git a/engine/lib/widgets.php b/engine/lib/widgets.php
index 46dedcea1..c96c1967a 100644
--- a/engine/lib/widgets.php
+++ b/engine/lib/widgets.php
@@ -56,7 +56,7 @@ function elgg_get_widgets($user_guid, $context) {
* @param int $access_id If not specified, it is set to the default access level
*
* @return int|false Widget GUID or false on failure
- * @since 1.8
+ * @since 1.8.0
*/
function elgg_create_widget($owner_guid, $handler, $context, $access_id = null) {
if (empty($owner_guid) || empty($handler) || !elgg_is_widget_type($handler)) {