chamilo / chamilo-lms

main/webservices/access_url.php

Doc Comments +3 added lines

@@ -20,6 +20,9 @@
 
 define('WS_ERROR_SECRET_KEY', 1);
 
+/**
+ * @param integer $code
+ */
 function return_error($code) {
     $fault = null;
     switch ($code) {

main/webservices/cm_webservice_course.php

Doc Comments +1 added lines

@@ -453,6 +453,7 @@
 	 * @param string Session id field name
 	 * @param string Session id value
 	 * @param int State (1 to subscribe, 0 to unsubscribe)
+	 * @param integer $state
 	 * @return mixed True on success, WSError otherwise
 	 */
 	protected function changeCourseSubscription($course_id_field_name, $course_id_value, $session_id_field_name, $session_id_value, $state) {

main/webservices/webservice_course.php

Doc Comments +1 added lines

@@ -453,6 +453,7 @@
 	 * @param string Session id field name
 	 * @param string Session id value
 	 * @param int State (1 to subscribe, 0 to unsubscribe)
+	 * @param integer $state
 	 * @return mixed True on success, WSError otherwise
 	 */
 	protected function changeCourseSubscription($course_id_field_name, $course_id_value, $session_id_field_name, $session_id_value, $state) {

main/inc/lib/document.lib.php

Doc Comments +21 added lines, -18 removed lines

@@ -277,7 +277,7 @@ 
     /**
      *  @param string
      *  @param string
-     * 	@return true if the user is allowed to see the document, false otherwise
+     * 	@return boolean if the user is allowed to see the document, false otherwise
      * 	@author Sergio A Kessler, first version
      * 	@author Roan Embrechts, bugfix
      *  @todo not only check if a file is visible, but also check if the user is allowed to see the file??
@@ -1527,7 +1527,7 @@ 
      * Return true if the documentpath have visibility=1 as
      * item_property (you should use the is_visible_by_id)
      *
-     * @param string $document_path the relative complete path of the document
+     * @param string $doc_path the relative complete path of the document
      * @param array  $course the _course array info of the document's course
      * @param int
      * @param string
@@ -1612,6 +1612,8 @@ 
      * @param   int
      * @param   int
      * @param bool
+     * @param integer $session_id
+     * @param integer $user_id
      * @return  bool
      */
     public static function is_visible_by_id(
@@ -2090,6 +2092,7 @@ 
      * @param	bool  	is file or string html
      * @param	string	type (one of the app tools) - optional (otherwise takes the current item's type)
      * @param	int		level of recursivity we're in
+     * @param string $source_html
      * @return	array	List of file paths. An additional field containing 'local' or 'remote' helps determine
      * if the file should be copied into the zip or just linked
      */
@@ -2913,6 +2916,7 @@ 
 
     /**
      * Obtains the text inside the file with the right parser
+     * @param string $doc_path
      */
     public static function get_text_content($doc_path, $doc_mime)
     {
@@ -3163,6 +3167,7 @@ 
      * Shows a play icon next to the document title in the document list
      * @param int
      * @param string
+     * @param integer|null $i
      * @return string	html content
      */
     static function generate_media_preview($i, $type = 'simple')
@@ -3557,7 +3562,7 @@ 
      * @param bool $add_move_button
      * @param string $target
      * @param string $overwrite_url
-     * @return null|string
+     * @return string
      */
     private static function parseFile(
         $course_info,
@@ -4058,7 +4063,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public static function get_web_odf_extension_list()
     {
@@ -4067,10 +4072,10 @@ 
 
     /**
      * Set of extension allowed to use Jodconverter
-     * @param $mode 'from'
+     * @param string $mode 'from'
      *              'to'
      *              'all'
-     * @param $format   'text'
+     * @param string $format   'text'
      *                  'spreadsheet'
      *                  'presentation'
      *                  'drawing'
@@ -4274,7 +4279,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public static function get_system_folders()
     {
@@ -4292,7 +4297,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public static function getProtectedFolderFromStudent()
     {
@@ -4448,7 +4453,7 @@ 
      * Requires the ffmpeg lib. In ubuntu: sudo apt-get install ffmpeg
      * @param string $wavFile
      * @param bool $removeWavFileIfSuccess
-     * @return bool
+     * @return string|false
      */
     public static function convertWavToMp3($wavFile, $removeWavFileIfSuccess = false)
     {
@@ -5536,9 +5541,6 @@ 
     /**
      * Creates the row of edit icons for a file/folder
      *
-     * @param string $curdirpath current path (cfr open folder)
-     * @param string $type (file/folder)
-     * @param string $path dbase path of file/folder
      * @param int $visibility (1/0)
      * @param int $id dbase id of the document
      * @return string html img tags with hyperlinks
@@ -5867,7 +5869,7 @@ 
     /**
      * Gets the path translated with title of docs and folders
      * @param string $path the real path
-     * @return the path which should be displayed
+     * @return string path which should be displayed
      */
     public static function get_titles_of_path($path)
     {
@@ -5922,7 +5924,8 @@ 
 
     /**
      * Checks whether the user is in shared folder
-     * @return return bool Return true when user is into shared folder
+     * @param integer $current_session_id
+     * @return boolean bool Return true when user is into shared folder
      */
     public static function is_shared_folder($curdirpath, $current_session_id)
     {
@@ -5938,7 +5941,7 @@ 
 
     /**
      * Checks whether the user is into any user shared folder
-     * @return return bool Return true when user is in any user shared folder
+     * @return boolean bool Return true when user is in any user shared folder
      */
     public static function is_any_user_shared_folder($path, $current_session_id)
     {
@@ -6152,7 +6155,7 @@ 
      * @param int $id
      * @param array $courseInfo
      * @param int $sessionId
-     * @return bool
+     * @return boolean|null
      */
     public static function downloadDeletedDocument($id, $courseInfo, $sessionId)
     {
@@ -6171,7 +6174,7 @@ 
      * @param array $courseInfo
      * @param int $sessionId
      *
-     * @return bool
+     * @return false|null
      */
     public static function downloadAllDeletedDocument($courseInfo, $sessionId)
     {
@@ -6210,7 +6213,7 @@ 
      * @param array $courseInfo
      * @param int $sessionId
      *
-     * @return bool
+     * @return false|null
      */
     public function deleteDocumentsFromSession($courseInfo, $sessionId)
     {

main/dropbox/dropbox_functions.inc.php

Doc Comments +8 added lines, -7 removed lines

@@ -22,7 +22,7 @@ 
 
 /**
 * This function is a wrapper function for the multiple actions feature.
-* @return   Mixed   If there is a problem, return a string message, otherwise nothing
+* @return   string|null   If there is a problem, return a string message, otherwise nothing
 * @author   Patrick Cool <patrick.cool@UGent.be>, Ghent University
 * @version  march 2006
 */
@@ -209,9 +209,9 @@ 
 *
 * @param $id the id of the file we are moving
 * @param $target the id of the folder we are moving to
-* @param $part are we moving a received file or a sent file?
+* @param string $part are we moving a received file or a sent file?
 *
-* @return language string
+* @return string string
 *
 * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
 * @version march 2006
@@ -290,7 +290,7 @@ 
 * @param $id the unique id of the file
 * @param $part are we dealing with a sent or with a received file?
 *
-* @return html code
+* @return string code
 *
 * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
 * @version march 2006
@@ -786,6 +786,7 @@ 
 }
 
 /**
+* @param string $user_id
 * @return boolean indicating if user with user_id=$user_id is a course member
 * @todo check if this function is still necessary. There might be a library function for this.
 */
@@ -1147,7 +1148,7 @@ 
 /**
 * This function returns the html code to display the feedback messages on a given dropbox file
 * @param $feedback_array an array that contains all the feedback messages about the given document.
-* @return html code
+* @return string code
 * @todo add the form for adding new comment (if the other party has not deleted it yet).
 *
 * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
@@ -1164,7 +1165,7 @@ 
 
 /**
 * this function returns the code for the form for adding a new feedback message to a dropbox file.
-* @return html code
+* @return string code
 *
 * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
 * @version march 2006
@@ -1225,7 +1226,7 @@ 
 }
 
 /**
-* @return a language string (depending on the success or failure.
+* @return string language string (depending on the success or failure.
 *
 * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
 * @version march 2006

main/coursecopy/classes/CourseRestorer.class.php

Doc Comments +8 added lines, -2 removed lines

@@ -84,7 +84,7 @@ 
 
     /**
      * CourseRestorer constructor.
-     * @param array $course
+     * @param Course $course
      */
     public function __construct($course)
     {
@@ -133,7 +133,7 @@ 
 	 * @param int	    $session_id
 	 * @param bool	    $update_course_settings Course settings are going to be restore?
      * @param bool      $respect_base_content
-     * @return bool
+     * @return false|null
 	 */
     public function restore(
         $destination_course_code = '',
@@ -1154,6 +1154,7 @@ 
 
 	/**
 	 * Restore a forum-topic
+	 * @param false|string $forum_id
 	 */
     public function restore_topic($thread_id, $forum_id, $sessionId = 0)
     {
@@ -1210,6 +1211,7 @@ 
 	/**
 	 * Restore a forum-post
 	 * @TODO Restore tree-structure of posts. For example: attachments to posts.
+	 * @param false|string $topic_id
 	 */
     public function restore_post($id, $topic_id, $forum_id, $sessionId = 0)
     {
@@ -2307,6 +2309,7 @@ 
 
 	/**
 	 * Check availability of a survey code
+	 * @param string $survey_code
 	 */
     public function is_survey_code_available($survey_code)
     {
@@ -2321,6 +2324,7 @@ 
 
 	/**
 	 * Restore survey-questions
+	 * @param string $survey_id
 	 */
     public function restore_survey_question($id, $survey_id)
     {
@@ -2777,6 +2781,8 @@ 
     * @param string The path origin
     * @param string The path destination
     * @param boolean Option Overwrite
+    * @param string $source
+    * @param string $dest
     * @return void()
     * @deprecated
     */

main/admin/user_list.php

Doc Comments +1 added lines, -1 removed lines

@@ -288,7 +288,7 @@
  * This function defines globals.
  * @param  int $userId
  *
- * @return bool    False on failure, redirection on success
+ * @return false|null    False on failure, redirection on success
  * @author Evie Embrechts
  * @author Yannick Warnier <yannick.warnier@dokeos.com>
 */

main/inc/lib/career.lib.php

Doc Comments +1 added lines, -1 removed lines

@@ -84,7 +84,7 @@
 
     /**
      * Available driver list.
-     * @return array
+     * @return string[]
      */
     private function getDefaultDriverList()
     {

main/inc/lib/api.lib.php

Doc Comments +52 added lines, -25 removed lines

@@ -575,7 +575,6 @@ 
  * Also, this function provides conversion between path types, in this case the input path points inside the Chamilo area too.
  *
  * See $_configuration['course_folder'] in the configuration.php to alter the WEB_COURSE_PATH and SYS_COURSE_PATH parameters.
- * @param string $type              The requested path type (a defined constant), see the examples.
  * @param string $path (optional)   A path which type is to be converted. Also, it may be a defined constant for a path.
  * This parameter has meaning when $type parameter has one of the following values: TO_WEB, TO_SYS, TO_REL. Otherwise it is ignored.
  * @return string                   The requested path or the converted path.
@@ -1070,7 +1069,7 @@ 
  * Checks the RFC 3986 syntax of a given URL.
  * @param string $url       The URL to be checked.
  * @param bool $absolute    Whether the URL is absolute (beginning with a scheme such as "http:").
- * @return bool             Returns the URL if it is valid, FALSE otherwise.
+ * @return string|false             Returns the URL if it is valid, FALSE otherwise.
  * This function is an adaptation from the function valid_url(), Drupal CMS.
  * @link http://drupal.org
  * Note: The built-in function filter_var($urs, FILTER_VALIDATE_URL) has a bug for some versions of PHP.
@@ -1650,6 +1649,7 @@ 
  * Gets a course setting from the current course_setting table. Try always using integer values.
  * @param string    The name of the setting we want from the table
  * @param string    Optional: course code
+ * @param string $setting_name
  * @return mixed    The value of that setting in that table. Return -1 if not found.
  */
 function api_get_course_setting($setting_name, $course_code = null)
@@ -1957,7 +1957,7 @@ 
 /**
  * Checks a password to see wether it is OK to use.
  * @param string $password
- * @return true if the password is acceptable, false otherwise
+ * @return boolean if the password is acceptable, false otherwise
  * Notes about what a password "OK to use" is:
  * 1. The password should be at least 5 characters long.
  * 2. Only English letters (uppercase or lowercase, it doesn't matter) and digits are allowed.
@@ -2129,7 +2129,7 @@ 
      * @author Hugues Peeters <peeters@ipm.ucl.ac.be>
      * @param  string $failure_type - the type of failure
      * @global array  $api_failureList
-     * @return bolean false to stay consistent with the main script
+     * @return boolean false to stay consistent with the main script
      */
     static function set_failure($failure_type) {
         global $api_failureList;
@@ -3196,8 +3196,8 @@ 
 
 /**
 * Checks whether the user is allowed in a specific tool for a specific action
-* @param $tool the tool we are checking if the user has a certain permission
-* @param $action the action we are checking (add, edit, delete, move, visibility)
+* @param string $tool the tool we are checking if the user has a certain permission
+* @param string $action the action we are checking (add, edit, delete, move, visibility)
 * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
 * @author Julio Montoya
 * @version 1.0
@@ -3496,7 +3496,7 @@ 
 /**
  * Gets a UNIX timestamp from a database (MySQL) datetime format string
  * @param $last_post_datetime standard output date in a sql query
- * @return unix timestamp
+ * @return integer timestamp
  * @author Toon Van Hoecke <Toon.VanHoecke@UGent.be>
  * @version October 2003
  * @desc convert sql date to unix timestamp
@@ -3529,6 +3529,9 @@ 
  * @param string    Tool (learnpath, document, etc)
  * @param int       The item ID in the given tool
  * @param int       The session ID (optional)
+ * @param string $tool
+ * @param integer $user_id
+ * @param string $type
  * @return int      -1 on error, 0 if invisible, 1 if visible
  */
 function api_get_item_visibility(
@@ -3597,7 +3600,7 @@ 
  * @param int $userId
  * @param int $groupId
  * @param int $sessionId
- * @return void
+ * @return false|null
  */
 function api_item_property_delete(
     $courseInfo,
@@ -3652,7 +3655,7 @@ 
  * @param array $_course array with course properties
  * @param string $tool tool id, linked to 'rubrique' of the course tool_list (Warning: language sensitive !!)
  * @param int $item_id id of the item itself, linked to key of every tool ('id', ...), "*" = all items of the tool
- * @param string $lastedit_type add or update action
+ * @param string $last_edit_type add or update action
  * (1) message to be translated (in trad4all) : e.g. DocumentAdded, DocumentUpdated;
  * (2) "delete"
  * (3) "visible"
@@ -3935,6 +3938,8 @@ 
  * @param string    tool name, linked to 'rubrique' of the course tool_list (Warning: language sensitive !!)
  * @param int       id of the item itself, linked to key of every tool ('id', ...), "*" = all items of the tool
  * @param int $session_id
+ * @param string $tool
+ * @param string $course_code
  * @return array All fields from c_item_property (all rows found) or empty array
  */
 function api_get_item_property_by_tool($tool, $course_code, $session_id = null)
@@ -4197,7 +4202,7 @@ 
  * Displays a form (drop down menu) so the user can select his/her preferred language.
  * The form works with or without javascript
  * @param  boolean Hide form if only one language available (defaults to false = show the box anyway)
- * @return void Display the box directly
+ * @return null|string Display the box directly
  */
 function api_display_language_form($hide_if_no_choice = false)
 {
@@ -4477,6 +4482,7 @@ 
  * and also when a user subscribes to courses (the new course is added at the end of the main category
  * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
  * @param int $user_course_category: the id of the user_course_category
+ * @param integer $user_id
  * @return int the value of the highest sort of the user_course_category
  */
 function api_max_sort_value($user_course_category, $user_id)
@@ -4685,6 +4691,8 @@ 
  * @param the dest folder
  * @param an array of excluded file_name (without extension)
  * @param copied_files the returned array of copied files
+ * @param string $source
+ * @param string $dest
  */
 function copyr($source, $dest, $exclude = array(), $copied_files = array()) {
     if (empty($dest)) { return false; }
@@ -4724,6 +4732,11 @@ 
 }
 
 // TODO: Using DIRECTORY_SEPARATOR is not recommended, this is an obsolete approach. Documentation header to be added here.
+/**
+ * @param string $pathname
+ * @param string $base_path_document
+ * @param integer $session_id
+ */
 function copy_folder_course_session(
     $pathname,
     $base_path_document,
@@ -4809,6 +4822,9 @@ 
 }
 
 // TODO: chmodr() is a better name. Some corrections are needed. Documentation header to be added here.
+/**
+ * @param string $path
+ */
 function api_chmod_R($path, $filemode) {
     if (!is_dir($path)) {
         return chmod($path, $filemode);
@@ -4891,7 +4907,7 @@ 
  *   version = VERSION
  * @endverbatim
  * </code>
- * @param $filename
+ * @param string $filename
  *   The file we are parsing. Accepts file with relative or absolute path.
  * @return
  *   The info array.
@@ -4983,7 +4999,7 @@ 
 /**
  * Checks whether status given in parameter exists in the platform
  * @param mixed the status (can be either int either string)
- * @return true if the status exists, else returns false
+ * @return boolean if the status exists, else returns false
  */
 function api_status_exists($status_asked) {
     global $_status_list;
@@ -5005,7 +5021,7 @@ 
 
 /**
  * Gets the status langvars list
- * @return array the list of status with their translations
+ * @return string[] the list of status with their translations
  */
 function api_get_status_langvars() {
     return array(
@@ -5081,6 +5097,7 @@ 
  * @param string    The sub-variable if any (in most cases, this will remain null)
  * @param string    The category if any (in most cases, this will remain null)
  * @param int       The access_url for which this parameter is valid
+ * @param string $cat
  */
 function api_set_setting($var, $value, $subvar = null, $cat = null, $access_url = 1)
 {
@@ -5178,6 +5195,8 @@ 
  * @param string    Value
  * @param int       Access URL. Optional. Defaults to 1
  * @param array     Optional array of filters on field type
+ * @param string $category
+ * @param string $value
  */
 function api_set_settings_category($category, $value = null, $access_url = 1, $fieldtype = array())
 {
@@ -5421,6 +5440,10 @@ 
  * @param string    The subkey text
  * @param int       The access_url for which this parameter is valid
  * @param int       The changeability of this setting for non-master urls
+ * @param string $val
+ * @param string $var
+ * @param string $sk
+ * @param string $c
  * @return boolean  true on success, false on failure
  */
 function api_add_setting($val, $var, $sk = null, $type = 'textfield', $c = null, $title = '', $com = '', $sc = null, $skt = null, $a = 1, $v = 0) {
@@ -5686,6 +5709,7 @@ 
  * @param String the tool of the element
  * @param int the element id in database
  * @param int the session_id to compare with element session id
+ * @param string $tool
  * @return boolean true if the element is in the session, false else
  */
 function api_is_element_in_the_session($tool, $element_id, $session_id = null) {
@@ -5731,8 +5755,6 @@ 
  * Replaces "forbidden" characters in a filename string.
  *
  * @param string $filename
- * @param int $length
- * @param bool $file_name
  *
  * @return string
  */
@@ -5968,6 +5990,7 @@ 
  * @link http://php.net/manual/en/function.getimagesize.php
  * @link http://www.dokeos.com/forum/viewtopic.php?t=12345
  * @link http://www.dokeos.com/forum/viewtopic.php?t=16355
+ * @return integer
  */
 function api_getimagesize($path) {
     $image = new Image($path);
@@ -6128,6 +6151,7 @@ 
  * with his user id and the access_url_id=1
  *
  * @author Julio Montoya
+ * @param integer $user_id
  */
 function api_is_global_platform_admin($user_id = null)
 {
@@ -6189,7 +6213,7 @@ 
  * @param int $admin_id_to_check
  * @param int  $my_user_id
  * @param bool $allow_session_admin
- * @return bool
+ * @return boolean|null
  */
 function api_protect_super_admin($admin_id_to_check, $my_user_id = null, $allow_session_admin = false)
 {
@@ -6431,6 +6455,7 @@ 
 
 /**
  * Returns the <link> HTML tag
+ * @param string $file
  */
 function api_get_css($file, $media = 'screen') {
     return '<link href="'.$file.'" rel="stylesheet" media="'.$media.'" type="text/css" />'."\n";
@@ -6568,7 +6593,8 @@ 
  * This function relies on api_get_course_info()
  * @param   string  The course code - optional (takes it from session if not given)
  * @param   int     The session id  - optional (takes it from session if not given)
- * @return  mixed   The URL of the course or null if something does not work
+ * @param integer $session_id
+ * @return  string|null   The URL of the course or null if something does not work
  * @author  Julio Montoya <gugli100@gmail.com>
  */
 function api_get_course_url($course_code = null, $session_id = null)
@@ -6683,7 +6709,7 @@ 
  * @param int       LINK_EXERCISE, LINK_STUDENTPUBLICATION, LINK_LEARNPATH LINK_FORUM_THREAD, LINK_ATTENDANCE
  * see gradebook/lib/be/linkfactory
  * @param string    course code
- * @return boolean
+ * @return false|null
  */
 function api_block_course_item_locked_by_gradebook($item_id, $link_type, $course_code = null) {
     if (api_is_platform_admin()) {
@@ -6724,7 +6750,7 @@ 
 /**
  * Returns an array of global configuration settings which should be ignored
  * when printing the configuration settings screens
- * @return array Array of strings, each identifying one of the excluded settings
+ * @return string[] Array of strings, each identifying one of the excluded settings
  */
 function api_get_locked_settings() {
     return array(
@@ -6767,7 +6793,7 @@ 
  * false if he isn't. If the user ID is given and is an integer, then the same
  * ID is simply returned
  * @param  integer User ID
- * @return mixed Integer User ID is logged in, or false otherwise
+ * @return boolean Integer User ID is logged in, or false otherwise
  */
 function api_user_is_login($user_id = null) {
     $user_id = empty($user_id) ? api_get_user_id() : intval($user_id);
@@ -6802,6 +6828,7 @@ 
  * Checks whether an IP is included inside an IP range
  * @param string IP address
  * @param string IP range
+ * @param string $ip
  * @return bool True if IP is in the range, false otherwise
  * @author claudiu at cnixs dot com  on http://www.php.net/manual/fr/ref.network.php#55230
  * @author Yannick Warnier for improvements and managment of multiple ranges
@@ -7185,6 +7212,7 @@ 
 /**
  * Tries to set memory limit, if authorized and new limit is higher than current
  * @param string New memory limit
+ * @param string $mem
  * @return bool True on success, false on failure or current is higher than suggested
  * @assert (null) === false
  * @assert (-1) === false
@@ -7241,7 +7269,6 @@ 
 
 /**
  * Finds all the information about a user from username instead of user id
- * @param string $username
  *
  * @return array $user_info user_id, lastname, firstname, username, email, ...
  * @author Yannick Warnier <yannick.warnier@beeznest.com>
@@ -7263,7 +7290,6 @@ 
 
 /**
  *
- * @param string $inputId the jquery id example: #password
  *
  * @return string
  */
@@ -7388,6 +7414,7 @@ 
 /**
  * Remove tags from HTML anf return the $in_number_char first non-HTML char
  * Postfix the text with "..." if it has been truncated.
+ * @param integer $in_number_char
  * @return string
  * @author hubert borderiou
  */
@@ -7432,7 +7459,7 @@ 
 /**
  * @param string $tool
  * @param string $setting
- * @param mixed $defaultValue
+ * @param integer $defaultValue
  * @return string
  */
 function api_get_default_tool_setting($tool, $setting, $defaultValue)
@@ -7557,7 +7584,7 @@ 
 }
 
 /**
- * @return true if course_code for direct course access after login is set
+ * @return boolean if course_code for direct course access after login is set
  */
 function exist_firstpage_parameter()
 {
@@ -7849,7 +7876,7 @@ 
  * @param array     data file (path and filename)
  * @param array     data to attach a file (optional)
  * @param bool      True for attaching a embedded file inside content html (optional)
- * @return          returns true if mail was sent
+ * @return          integer true if mail was sent
  * @see             class.phpmailer.php
  */
 function api_mail_html(