adding since tags. information is useful for developers that use SquirrelMail API.

[squirrelmail.git] / functions / identity.php

diff --git a/functions/identity.php b/functions/identity.php
index ade32603c17f8ae4db6a34d4b9885034e7da1375..62bcf3b5fb8f7cae0aebbd626f1c56fd1e6c8207 100644 (file)
--- a/functions/identity.php
+++ b/functions/identity.php
@@ -10,20 +10,24 @@
  *
  * @version $Id$
  * @package squirrelmail
+ * @since 1.4.2
  */
 
-/** Used to simplify includes */
+/** @ignore
+ * Used to simplify includes */
 if (!defined('SM_PATH')) {
     define('SM_PATH','../');
 }
 
+/** preference and signature functions */
 include_once(SM_PATH . 'include/load_prefs.php');
 
 /**
-* Returns an array of all the identities.
-* Array is keyed: full_name, reply_to, email_address, index, signature
-* @return array full_name,reply_to,email_address,index,signature
-*/
+ * Returns an array of all the identities.
+ * Array is keyed: full_name, reply_to, email_address, index, signature
+ * @return array full_name,reply_to,email_address,index,signature
+ * @since 1.4.2
+ */
 function get_identities() {
 
     global $username, $data_dir, $domain;
@@ -63,6 +67,7 @@ function get_identities() {
  * Function to save the identities array
  *
  * @param  array     $identities     Array of identities
+ * @since 1.5.1 and 1.4.5
  */
 function save_identities($identities) {
 
@@ -112,6 +117,7 @@ function save_identities($identities) {
  * @param   int         $id             Identity to modify
  * @param   string      $action         Action to perform
  * @return  array
+ * @since 1.5.1 and 1.4.5
  */
 function sqfixidentities( $identities, $id, $action ) {
 
@@ -185,6 +191,7 @@ function sqfixidentities( $identities, $id, $action ) {
  *
  * @param   array   $identity   Identitiy Array
  * @return  boolean
+ * @since 1.5.1 and 1.4.5
  */
 function empty_identity($ident) {
     if (empty($ident['full_name']) && empty($ident['email_address']) && empty($ident['signature']) && empty($ident['reply_to'])) {
@@ -194,4 +201,4 @@ function empty_identity($ident) {
     }
 }
 
-?>
+?>
\ No newline at end of file