Show
Ignore:
Timestamp:
02/23/06 20:09:13 (6 years ago)
Author:
john
Message:

added in phpDoc commenting tests docs - Walt

Files:
1 modified

Legend:

Unmodified
Added
Removed

  • trunk/trax/script/generate.php

    r117 r138  
    11#! /usr/local/bin/php 
    22<?php 
    3 # $Id$ 
    4 # 
    5 # Copyright (c) 2005 John Peterson 
    6 # 
    7 # Permission is hereby granted, free of charge, to any person obtaining 
    8 # a copy of this software and associated documentation files (the 
    9 # "Software"), to deal in the Software without restriction, including 
    10 # without limitation the rights to use, copy, modify, merge, publish, 
    11 # distribute, sublicense, and/or sell copies of the Software, and to 
    12 # permit persons to whom the Software is furnished to do so, subject to 
    13 # the following conditions: 
    14 # 
    15 # The above copyright notice and this permission notice shall be 
    16 # included in all copies or substantial portions of the Software. 
    17 # 
    18 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 
    19 # EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 
    20 # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND 
    21 # NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE 
    22 # LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION 
    23 # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION 
    24 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 
    25  
     3/** 
     4 *  Command line script to generate a Trax application 
     5 * 
     6 *  (PHP 5) 
     7 * 
     8 *  @package PHPonTrax 
     9 *  @version $Id$ 
     10 *  @copyright (c) 2005 John Peterson 
     11 * 
     12 *  Permission is hereby granted, free of charge, to any person obtaining 
     13 *  a copy of this software and associated documentation files (the 
     14 *  "Software"), to deal in the Software without restriction, including 
     15 *  without limitation the rights to use, copy, modify, merge, publish, 
     16 *  distribute, sublicense, and/or sell copies of the Software, and to 
     17 *  permit persons to whom the Software is furnished to do so, subject to 
     18 *  the following conditions: 
     19 * 
     20 *  The above copyright notice and this permission notice shall be 
     21 *  included in all copies or substantial portions of the Software. 
     22 * 
     23 *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 
     24 *  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 
     25 *  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND 
     26 *  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE 
     27 *  LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION 
     28 *  OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION 
     29 *  WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 
     30 * 
     31 * 
     32 *  <p>Sets up the Trax environment, creates a {@link TraxGenerator} 
     33 *  object and calls its run() method to process the command line 
     34 *  arguments to the script</p> 
     35 * 
     36 *  <p>Invoked from the command line by</p> 
     37 *  <p> 
     38 *  <samp>php script/generate.php</samp> <i>command [ arguments... ]</i> 
     39 *  </p> 
     40 * 
     41 *  <p>See the {@link TraxGenerator} class definition for valid values 
     42 *  of <i>command [ arguments... ]</i></p> 
     43 */ 
    2644if (substr(PHP_OS, 0, 3) == 'WIN') { 
    2745    ini_set("include_path",ini_get("include_path").";".dirname(dirname(__FILE__))."/lib");  
    … …  
    2947    ini_set("include_path",ini_get("include_path").":".dirname(dirname(__FILE__)) . "/lib"); 
    3048}  
     49 
     50/** 
     51 *  Load definitions of the Trax environment from {@link environment.php} 
     52 */ 
    3153require_once(dirname(dirname(__FILE__)) . "/config/environment.php"); 
     54 
     55/** 
     56 *  Load definition of the {@link TraxGenerator} class 
     57 */ 
    3258require_once("trax_generator.php"); 
    3359