Changeset 701

Show
Ignore:
Timestamp:
12/15/07 14:40:15 (1 year ago)
Author:
laurentj
Message:

ticket #371 : finished to fix phpdoc errors and added @since tags

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • trunk/lib/jelix/core-modules/jelix/controllers/error.classic.php

    r699 r701  
    99 
    1010/** 
    11  * 
     11 * @package    jelix-modules 
     12 * @subpackage jelix 
    1213 */ 
    1314class errorCtrl extends jController { 

  • trunk/lib/jelix/core-modules/jelix/controllers/error.classic.php

    r699 r701  
    99 
    1010/** 
    11  * 
     11 * @package    jelix-modules 
     12 * @subpackage jelix 
    1213 */ 
    1314class errorCtrl extends jController { 

  • trunk/lib/jelix/core-modules/jelix/controllers/error.jsonrpc.php

    r699 r701  
    99 
    1010/** 
    11  * 
     11 * @package    jelix-modules 
     12 * @subpackage jelix 
    1213 */ 
    1314class errorCtrl extends jController { 

  • trunk/lib/jelix/core-modules/jelix/controllers/error.jsonrpc.php

    r699 r701  
    99 
    1010/** 
    11  * 
     11 * @package    jelix-modules 
     12 * @subpackage jelix 
    1213 */ 
    1314class errorCtrl extends jController { 

  • trunk/lib/jelix/core-modules/jelix/controllers/error.rdf.php

    r699 r701  
    99 
    1010/** 
    11  * 
     11 * @package    jelix-modules 
     12 * @subpackage jelix 
    1213 */ 
    1314class errorCtrl extends jController { 

  • trunk/lib/jelix/core-modules/jelix/controllers/error.rdf.php

    r699 r701  
    99 
    1010/** 
    11  * 
     11 * @package    jelix-modules 
     12 * @subpackage jelix 
    1213 */ 
    1314class errorCtrl extends jController { 

  • trunk/lib/jelix/core-modules/jelix/controllers/error.xmlrpc.php

    r699 r701  
    99 
    1010/** 
    11  * 
     11 * @package    jelix-modules 
     12 * @subpackage jelix 
    1213 */ 
    1314class errorCtrl extends jController { 

  • trunk/lib/jelix/core-modules/jelix/controllers/error.xmlrpc.php

    r699 r701  
    99 
    1010/** 
    11  * 
     11 * @package    jelix-modules 
     12 * @subpackage jelix 
    1213 */ 
    1314class errorCtrl extends jController { 

  • trunk/lib/jelix/core-modules/jelix/controllers/error.xul.php

    r699 r701  
    99 
    1010/** 
    11  * 
     11 * @package    jelix-modules 
     12 * @subpackage jelix 
    1213 */ 
    1314class errorCtrl extends jController { 

  • trunk/lib/jelix/core-modules/jelix/controllers/error.xul.php

    r699 r701  
    99 
    1010/** 
    11  * 
     11 * @package    jelix-modules 
     12 * @subpackage jelix 
    1213 */ 
    1314class errorCtrl extends jController { 

  • trunk/lib/jelix/core-modules/jelix/controllers/help.cmdline.php

    r699 r701  
    99 
    1010/** 
    11  * 
     11 * @package    jelix-modules 
     12 * @subpackage jelix 
    1213 */ 
    1314class helpCtrl extends jControllerCmdLine { 

  • trunk/lib/jelix/core-modules/jelix/controllers/help.cmdline.php

    r699 r701  
    99 
    1010/** 
    11  * 
     11 * @package    jelix-modules 
     12 * @subpackage jelix 
    1213 */ 
    1314class helpCtrl extends jControllerCmdLine { 

  • trunk/lib/jelix/core/jCoordinator.class.php

    r699 r701  
    6767     * List of all log messages 
    6868     * @var array 
     69     * @since 1.0 
    6970     */ 
    7071    public $logMessages=array(); 
    …… 
    153154     * of the logMessages properties to display them. 
    154155     * @param  string $message error message 
     156     * @since 1.0 
    155157     */ 
    156158    public function addLogMsg($message, $type='default'){ 

  • trunk/lib/jelix/core/jCoordinator.class.php

    r699 r701  
    6767     * List of all log messages 
    6868     * @var array 
     69     * @since 1.0 
    6970     */ 
    7071    public $logMessages=array(); 
    …… 
    153154     * of the logMessages properties to display them. 
    154155     * @param  string $message error message 
     156     * @since 1.0 
    155157     */ 
    156158    public function addLogMsg($message, $type='default'){ 

  • trunk/lib/jelix/core/jSession.class.php

    r673 r701  
    88* @link       http://www.jelix.org 
    99* @licence    GNU Lesser General Public Licence see LICENCE file or http://www.gnu.org/licenses/lgpl.html 
     10* @since 1.0 
    1011*/ 
    1112 
    …… 
    1516 * @package  jelix 
    1617 * @subpackage core 
     18 * @since 1.0 
    1719 */ 
    1820class jSession { 
    …… 
    2022    protected static $_params; 
    2123 
     24    /** 
     25     * start a session 
     26     */ 
    2227    public static function start(){ 
    2328        $params = $GLOBALS['gJConfig']->sessions; 
    …… 
    5560    } 
    5661 
    57  
     62    /** 
     63     * end a session 
     64     */ 
    5865    public static function end(){ 
    5966        session_write_close(); 
    …… 
    7279    } 
    7380 
    74  
     81    /** 
     82     * dao handler for session stored in database 
     83     */ 
    7584    public static function daoOpen ($save_path, $session_name) { 
    7685        return true; 
    7786    } 
    7887 
    79  
     88    /** 
     89     * dao handler for session stored in database 
     90     */ 
    8091    public static function daoClose() { 
    8192        return true; 
    8293    } 
    8394 
    84  
     95    /** 
     96     * dao handler for session stored in database 
     97     */ 
    8598    public static function daoRead ($id) { 
    8699        $session = self::_getDao()->get($id); 
    …… 
    93106    } 
    94107 
    95  
     108    /** 
     109     * dao handler for session stored in database 
     110     */ 
    96111    public static function daoWrite ($id, $data) { 
    97112        $dao = self::_getDao(); 
    …… 
    112127    } 
    113128 
    114  
     129    /** 
     130     * dao handler for session stored in database 
     131     */ 
    115132    public static function daoDestroy ($id) { 
    116133        if (isset($_COOKIE[session_name()])) { 
    …… 
    122139    } 
    123140 
    124  
     141    /** 
     142     * dao handler for session stored in database 
     143     */ 
    125144    public static function daoGarbageCollector ($maxlifetime) { 
    126145        $date = new jDateTime(); 

  • trunk/lib/jelix/core/jSession.class.php

    r673 r701  
    88* @link       http://www.jelix.org 
    99* @licence    GNU Lesser General Public Licence see LICENCE file or http://www.gnu.org/licenses/lgpl.html 
     10* @since 1.0 
    1011*/ 
    1112 
    …… 
    1516 * @package  jelix 
    1617 * @subpackage core 
     18 * @since 1.0 
    1719 */ 
    1820class jSession { 
    …… 
    2022    protected static $_params; 
    2123 
     24    /** 
     25     * start a session 
     26     */ 
    2227    public static function start(){ 
    2328        $params = $GLOBALS['gJConfig']->sessions; 
    …… 
    5560    } 
    5661 
    57  
     62    /** 
     63     * end a session 
     64     */ 
    5865    public static function end(){ 
    5966        session_write_close(); 
    …… 
    7279    } 
    7380 
    74  
     81    /** 
     82     * dao handler for session stored in database 
     83     */ 
    7584    public static function daoOpen ($save_path, $session_name) { 
    7685        return true; 
    7786    } 
    7887 
    79  
     88    /** 
     89     * dao handler for session stored in database 
     90     */ 
    8091    public static function daoClose() { 
    8192        return true; 
    8293    } 
    8394 
    84  
     95    /** 
     96     * dao handler for session stored in database 
     97     */ 
    8598    public static function daoRead ($id) { 
    8699        $session = self::_getDao()->get($id); 
    …… 
    93106    } 
    94107 
    95  
     108    /** 
     109     * dao handler for session stored in database 
     110     */ 
    96111    public static function daoWrite ($id, $data) { 
    97112        $dao = self::_getDao(); 
    …… 
    112127    } 
    113128 
    114  
     129    /** 
     130     * dao handler for session stored in database 
     131     */ 
    115132    public static function daoDestroy ($id) { 
    116133        if (isset($_COOKIE[session_name()])) { 
    …… 
    122139    } 
    123140 
    124  
     141    /** 
     142     * dao handler for session stored in database 
     143     */ 
    125144    public static function daoGarbageCollector ($maxlifetime) { 
    126145        $date = new jDateTime(); 

  • trunk/lib/jelix/core/response/jResponseLatexToPdf.class.php

    r699 r701  
    5555    public $pdflatexPath='pdflatex'; 
    5656 
     57    /** 
     58     * path to the cache directory. 
     59     * default is directory responseLatexToPdf in temp directory 
     60     * @since 1.0 
     61     */ 
    5762    public $cachePath= ''; 
    5863 

  • trunk/lib/jelix/core/response/jResponseLatexToPdf.class.php

    r699 r701  
    5555    public $pdflatexPath='pdflatex'; 
    5656 
     57    /** 
     58     * path to the cache directory. 
     59     * default is directory responseLatexToPdf in temp directory 
     60     * @since 1.0 
     61     */ 
    5762    public $cachePath= ''; 
    5863 

  • trunk/lib/jelix/core/response/jResponseRedirectUrl.class.php

    r627 r701  
    2929     * set the url with the referer URL 
    3030     * @return boolean true if there is a referer URL 
     31     * @since 1.0 
    3132     */ 
    3233    public function toReferer($defaultUrl='') { 

  • trunk/lib/jelix/core/response/jResponseRedirectUrl.class.php

    r627 r701  
    2929     * set the url with the referer URL 
    3030     * @return boolean true if there is a referer URL 
     31     * @since 1.0 
    3132     */ 
    3233    public function toReferer($defaultUrl='') { 

  • trunk/lib/jelix/core/response/jResponseTcpdf.class.php

    r698 r701  
    88* @link        http://www.jelix.org 
    99* @licence     GNU Lesser General Public Licence see LICENCE file or http://www.gnu.org/licenses/lgpl.html 
     10* @since 1.0 
    1011*/ 
    1112 
    12  
     13/** 
     14 * 
     15 */ 
    1316require_once (JELIX_LIB_UTILS_PATH.'jTcpdf.class.php'); 
    1417 
    …… 
    1720* @package  jelix 
    1821* @subpackage core_response 
     22* @since 1.0 
    1923*/ 
    2024class jResponseTcpdf  extends jResponse { 

  • trunk/lib/jelix/core/response/jResponseTcpdf.class.php

    r698 r701  
    88* @link        http://www.jelix.org 
    99* @licence     GNU Lesser General Public Licence see LICENCE file or http://www.gnu.org/licenses/lgpl.html 
     10* @since 1.0 
    1011*/ 
    1112 
    12  
     13/** 
     14 * 
     15 */ 
    1316require_once (JELIX_LIB_UTILS_PATH.'jTcpdf.class.php'); 
    1417 
    …… 
    1720* @package  jelix 
    1821* @subpackage core_response 
     22* @since 1.0 
    1923*/ 
    2024class jResponseTcpdf  extends jResponse { 

  • trunk/lib/jelix/dao/jDaoFactoryBase.class.php

    r699 r701  
    7171 
    7272    /** 
    73      *  
     73     * @since 1.0 
    7474     */ 
    7575    protected $_deleteBeforeEvent = false; 
     76    /** 
     77     * @since 1.0 
     78     */ 
    7679    protected $_deleteAfterEvent = false; 
     80    /** 
     81     * @since 1.0 
     82     */ 
    7783    protected $_deleteByBeforeEvent = false; 
     84    /** 
     85     * @since 1.0 
     86     */ 
    7887    protected $_deleteByAfterEvent = false; 
    7988 
     89    /** 
     90     * @since 1.0 
     91     */ 
    8092    protected $trueValue = 1; 
     93    /** 
     94     * @since 1.0 
     95     */ 
    8196    protected $falseValue = 0; 
    8297    /** 

  • trunk/lib/jelix/dao/jDaoFactoryBase.class.php

    r699 r701  
    7171 
    7272    /** 
    73      *  
     73     * @since 1.0 
    7474     */ 
    7575    protected $_deleteBeforeEvent = false; 
     76    /** 
     77     * @since 1.0 
     78     */ 
    7679    protected $_deleteAfterEvent = false; 
     80    /** 
     81     * @since 1.0 
     82     */ 
    7783    protected $_deleteByBeforeEvent = false; 
     84    /** 
     85     * @since 1.0 
     86     */ 
    7887    protected $_deleteByAfterEvent = false; 
    7988 
     89    /** 
     90     * @since 1.0 
     91     */ 
    8092    protected $trueValue = 1; 
     93    /** 
     94     * @since 1.0 
     95     */ 
    8196    protected $falseValue = 0; 
    8297    /** 

  • trunk/lib/jelix/db/jDbConnection.class.php

    r699 r701  
    127127      * @return string the prefixed table's name 
    128128      * @author Julien Issler 
    129       **/ 
     129      * @since 1.0 
     130      */ 
    130131    public function prefixTable($table_name){ 
    131132        if(!isset($this->profil['table_prefix'])) 
    …… 
    139140      * @return boolean 
    140141      * @author Julien Issler 
    141       **/ 
     142      * @since 1.0 
     143      */ 
    142144    public function hasTablePrefix(){ 
    143145        return (isset($this->profil['table_prefix']) && $this->profil['table_prefix'] != ''); 

  • trunk/lib/jelix/db/jDbConnection.class.php

    r699 r701  
    127127      * @return string the prefixed table's name 
    128128      * @author Julien Issler 
    129       **/ 
     129      * @since 1.0 
     130      */ 
    130131    public function prefixTable($table_name){ 
    131132        if(!isset($this->profil['table_prefix'])) 
    …… 
    139140      * @return boolean 
    140141      * @author Julien Issler 
    141       **/ 
     142      * @since 1.0 
     143      */ 
    142144    public function hasTablePrefix(){ 
    143145        return (isset($this->profil['table_prefix']) && $this->profil['table_prefix'] != ''); 

  • trunk/lib/jelix/db/jDbPDOConnection.class.php

    r699 r701  
    6060    * PDO constant name have been change between php 5.0 and 5.1. So we use our own constant. 
    6161    * @link http://lxr.php.net/source/php-src/ext/pdo/php_pdo_driver.h 
     62    * @since 1.0 
    6263    */ 
    6364    const JPDO_FETCH_OBJ = 5; // PDO::FETCH_OBJ 
    …… 
    183184     * @return string the prefixed table's name 
    184185     * @author Julien Issler 
     186     * @since 1.0 
    185187     */ 
    186188    public function prefixTable($table_name){ 
    …… 
    195197     * @return boolean 
    196198     * @author Julien Issler 
     199     * @since 1.0 
    197200     */ 
    198201    public function hasTablePrefix(){ 

  • trunk/lib/jelix/db/jDbPDOConnection.class.php

    r699 r701  
    6060    * PDO constant name have been change between php 5.0 and 5.1. So we use our own constant. 
    6161    * @link http://lxr.php.net/source/php-src/ext/pdo/php_pdo_driver.h 
     62    * @since 1.0 
    6263    */ 
    6364    const JPDO_FETCH_OBJ = 5; // PDO::FETCH_OBJ 
    …… 
    183184     * @return string the prefixed table's name 
    184185     * @author Julien Issler 
     186     * @since 1.0 
    185187     */ 
    186188    public function prefixTable($table_name){ 
    …… 
    195197     * @return boolean 
    196198     * @author Julien Issler 
     199     * @since 1.0 
    197200     */ 
    198201    public function hasTablePrefix(){ 

  • trunk/lib/jelix/tpl/jTpl.class.php

    r691 r701  
    120120     * @param array  $params  parameters for the zone 
    121121     * @see jZone 
     122     * @since 1.0 
    122123     */ 
    123124    function appendZone($name, $zoneName, $params=array()){ 

  • trunk/lib/jelix/tpl/jTpl.class.php

    r691 r701  
    120120     * @param array  $params  parameters for the zone 
    121121     * @see jZone 
     122     * @since 1.0 
    122123     */ 
    123124    function appendZone($name, $zoneName, $params=array()){ 

  • trunk/lib/jelix/utils/jDatatype.class.php

    r699 r701  
    170170    } 
    171171    /** 
    172      * @since 1.0RC1 
     172     * @since 1.0 
    173173     */ 
    174174    public function getFormat() { return $this->format; } 

  • trunk/lib/jelix/utils/jDatatype.class.php

    r699 r701  
    170170    } 
    171171    /** 
    172      * @since 1.0RC1 
     172     * @since 1.0 
    173173     */ 
    174174    public function getFormat() { return $this->format; } 

  • trunk/lib/jelix/utils/jTcpdf.class.php

    r696 r701  
    88* @link        http://www.jelix.org 
    99* @licence     GNU Lesser General Public Licence see LICENCE file or http://www.gnu.org/licenses/lgpl.html 
     10* @since 1.0 
    1011*/ 
    1112 
     13/** 
     14 * 
     15 */ 
    1216require_once (LIB_PATH.'tcpdf/tcpdf.php'); 
    1317 
    …… 
    1620 * @package    jelix 
    1721 * @subpackage utils 
     22 * @since 1.0 
    1823 */ 
    1924class jTcpdf extends TCPDF { 

  • trunk/lib/jelix/utils/jTcpdf.class.php

    r696 r701  
    88* @link        http://www.jelix.org 
    99* @licence     GNU Lesser General Public Licence see LICENCE file or http://www.gnu.org/licenses/lgpl.html 
     10* @since 1.0 
    1011*/ 
    1112 
     13/** 
     14 * 
     15 */ 
    1216require_once (LIB_PATH.'tcpdf/tcpdf.php'); 
    1317 
    …… 
    1620 * @package    jelix 
    1721 * @subpackage utils 
     22 * @since 1.0 
    1823 */ 
    1924class jTcpdf extends TCPDF { 

  • trunk/Makefile

    r677 r701  
    4646        $(PHP) build/buildjelix.php -D $(TESTPATHSWITCH) build/config/jelix-test.ini 
    4747        cp -R -f build/phpdoc/Converters/HTML/frames $(PHPDOC)phpDocumentor/Converters/HTML/ 
    48         $(PHPDOC)phpdoc  -d $(TESTPATH)/lib/jelix/ -t $(DOCSPATH) \ 
     48        $(PHPDOC)phpdoc \ 
     49        -d $(TESTPATH)/lib/jelix/,$(TESTPATH)/lib/jelix-modules/,$(TESTPATH)/lib/diff/,$(TESTPATH)/lib/json/,$(TESTPATH)/lib/tcpdf/,$(TESTPATH)/lib/wikirenderer/ \ 
     50        -t $(DOCSPATH) \ 
    4951        -o "HTML:frames:DOM/jelix" -s on -ct "contributor,licence" -i *.ini.php \ 
    5052        -ti "Jelix API Reference" -ric "README,INSTALL,CHANGELOG,CREDITS,LICENCE,VERSION,BUILD" 

  • trunk/Makefile

    r677 r701  
    4646        $(PHP) build/buildjelix.php -D $(TESTPATHSWITCH) build/config/jelix-test.ini 
    4747        cp -R -f build/phpdoc/Converters/HTML/frames $(PHPDOC)phpDocumentor/Converters/HTML/ 
    48         $(PHPDOC)phpdoc  -d $(TESTPATH)/lib/jelix/ -t $(DOCSPATH) \ 
     48        $(PHPDOC)phpdoc \ 
     49        -d $(TESTPATH)/lib/jelix/,$(TESTPATH)/lib/jelix-modules/,$(TESTPATH)/lib/diff/,$(TESTPATH)/lib/json/,$(TESTPATH)/lib/tcpdf/,$(TESTPATH)/lib/wikirenderer/ \ 
     50        -t $(DOCSPATH) \ 
    4951        -o "HTML:frames:DOM/jelix" -s on -ct "contributor,licence" -i *.ini.php \ 
    5052        -ti "Jelix API Reference" -ric "README,INSTALL,CHANGELOG,CREDITS,LICENCE,VERSION,BUILD" 
Download in other formats: Unified Diff Zip Archive