Changeset 226

Show
Ignore:
Timestamp:
08/01/06 18:43:03 (2 years ago)
Author:
laurentj
Message:

documentation de init.php et ajout tag makefile pour générer la doc avec phpdocumentor (experimental)

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved
  • trunk/lib/jelix/init.php

    r216 r226  
    11<?php 
    22/** 
     3* Initialize all defines and includes necessary files 
     4*  
    35* @package  jelix 
    46* @subpackage core 
     
    1113*/ 
    1214 
     15/** 
     16 * Version number of Jelix 
     17 * @name  JELIX_VERSION 
     18 */ 
    1319#expand define ('JELIX_VERSION', '__LIB_VERSION__'); 
     20 
     21/** 
     22 * base of namespace path used in xml files of jelix 
     23 * @name  JELIX_NAMESPACE_BASE 
     24 */ 
    1425define ('JELIX_NAMESPACE_BASE' , 'http://jelix.org/ns/'); 
    1526 
    16 // all path needed by jelix 
     27 
    1728define ('JELIX_LIB_PATH',         dirname (__FILE__).'/'); 
    1829define ('JELIX_LIB_CORE_PATH',    JELIX_LIB_PATH.'core/'); 
     
    4960require_once (JELIX_LIB_CORE_PATH . 'jIPlugin.iface.php'); 
    5061 
    51 // global variables 
     62/** 
     63 * The main object of Jelix which process all things 
     64 * @global jCoordinator $gJCoord 
     65 * @name $gJCoord 
     66 */ 
    5267$gJCoord = null; 
    53 $gJConfig = array(); 
     68 
     69/** 
     70 * Object that contains all configuration values 
     71 * @global stdobject $gJConfig 
     72 * @name $gJConfig 
     73 */ 
     74$gJConfig = null; 
     75 
     76 
     77/** 
     78 * array used as a stack to store module context 
     79 * @global array $gJContext 
     80 * @name $gJContext 
     81 */ 
    5482$gJContext = array(); 
    5583 
     84/** 
     85 * contains path for __autoload function 
     86 * @global array $gLibPath 
     87 * @name $gLibPath 
     88 * @see __autoload() 
     89 */ 
    5690$gLibPath=array('Db'=>JELIX_LIB_DB_PATH, 'Dao'=>JELIX_LIB_DAO_PATH, 
    5791 'Forms'=>JELIX_LIB_FORMS_PATH, 'Event'=>JELIX_LIB_EVENTS_PATH, 
    5892 'Tpl'=>JELIX_LIB_TPL_PATH, 'Acl'=>JELIX_LIB_ACL_PATH, 'Controller'=>JELIX_LIB_CTRL_PATH); 
    5993 
    60  
     94/**  
     95 * __autoload function used by php to try to load an unknown class 
     96 */ 
    6197function __autoload($class){ 
    6298   if(preg_match('/^j(Dao|Tpl|Acl|Event|Db|Controller|Forms).*$/', $class, $m)){ 
  • trunk/Makefile

    r193 r226  
    11SHELL=/bin/sh 
    22PHP=/usr/bin/php 
     3PHPDOC=../../phpdoc/phpdoc 
    34 
    45ifndef LIB_VERSION 
     
    3435DEV=_dev 
    3536endif 
     37ifndef DOCS 
     38DOCS=_docs 
     39endif 
     40 
     41 
    3642 
    3743DISTJELIX="$(DIST)/jelix-$(LIB_VERSION)" 
     
    5561        @echo "   jtpl jtpl-dist" 
    5662        @echo "   jbt-dist" 
     63        @echo "   docs" 
    5764        @echo "param�es facultatifs (valeurs actuelles) :" 
    5865        @echo "   DIST : repertoire cible pour les distributions (" $(DIST) ")" 
     
    139146        tar czf $(DIST)/jbuildtools-$(JBT_VERSION).tar.gz  -C $(DIST) jbuildtools/ 
    140147 
    141  
     148docs: dev-jelix-lib 
     149        $(PHPDOC) -d $(DISTHACKER)/lib/jelix/ -o HTML:Smarty:jelix -t $(DOCS) -ti "Jelix API Reference" 
Download in other formats: Unified Diff Zip Archive