Changeset 1238

Show
Ignore:
Timestamp:
11/04/06 23:49:45 (2 years ago)
Author:
dominik
Message:

more phpdoc

Location:
trunk/src
Files:
12 modified

Legend:

Unmodified
Added
Removed

  • trunk/src/filter/AgaviFilterChain.class.php

    r1063 r1238  
    5151   
    5252  /** 
    53    * @var        AgaviRespinse The Response instance that is handed to filters. 
     53   * @var        AgaviResponse The Response instance that is handed to filters. 
    5454   */ 
    5555  protected $response = null; 
    … …  
    9797   * Register a filter with this chain. 
    9898   * 
    99    * @param      AgaviFilter A Filter implementation instance. 
     99   * @param      AgaviIFilter A Filter implementation instance. 
    100100   * 
    101101   * @author     Sean Kerr <skerr@mojavi.org> 

  • trunk/src/filter/AgaviFormPopulationFilter.class.php

    r1206 r1238  
    6666   * 
    6767   * @param      AgaviFilterChain The filter chain. 
     68   * @param      AgaviResponse    A Response instance. 
    6869   * 
    6970   * @throws     <b>AgaviFilterException</b> If an error occurs during execution. 
    … …  
    409410   * @param      array        An associative array of initialization parameters. 
    410411   * 
    411    * @throws     <b>AgaviFilterException</b> If an error occurs during initialization 
     412   * @throws     <b>AgaviFilterException</b> If an error occurs during  
     413   *                                         initialization 
    412414   * 
    413415   * @author     David Zuelke <dz@bitxtender.com> 

  • trunk/src/logging/AgaviFileLoggerAppender.class.php

    r1233 r1238  
    6262   *                                          appending. 
    6363   * 
    64    * @return     integer 
     64   * @return     resource The open file handle. 
    6565   * 
    6666   * @author     Bob Zoller <bob@agavi.org> 

  • trunk/src/logging/AgaviLogger.class.php

    r1233 r1238  
    1515 
    1616/** 
    17  * AgaviLogger provides an easy way to manage multiple log destinations and write 
    18  * to them all simultaneously. 
     17 * AgaviLogger provides an easy way to manage multiple log destinations and  
     18 * write to them all simultaneously. 
    1919 * 
    2020 * @package    agavi 
    … …  
    106106   * If an appender with the name already exists, an exception will be thrown. 
    107107   * 
    108    * @param      string        An appender name. 
     108   * @param      string              An appender name. 
    109109   * @param      AgaviLoggerAppender An Appender instance. 
    110110   * 
    111    * @throws     <b>AgaviLoggingException</b> If an appender with the name already 
    112    *                                          exists. 
     111   * @throws     <b>AgaviLoggingException</b> If an appender with the name  
     112   *                                          already exists. 
    113113   * 
    114114   * @author     Sean Kerr <skerr@mojavi.org> 

  • trunk/src/logging/AgaviLoggerAppender.class.php

    r1233 r1238  
    1515 
    1616/** 
    17  * AgaviLoggerAppender allows you to specify a destination for log data and provide 
    18  * a custom layout for it, through which all log messages will be formatted. 
     17 * AgaviLoggerAppender allows you to specify a destination for log data and  
     18 * provide a custom layout for it, through which all log messages will be  
     19 * formatted. 
    1920 * 
    2021 * @package    agavi 
    … …  
    6970   * Retrieve the layout. 
    7071   * 
    71    * @return     AgaviLoggerLayout A Layout instance, if it has been set, otherwise null. 
     72   * @return     AgaviLoggerLayout A Layout instance, if it has been set,  
     73   *                               otherwise null. 
    7274   * 
    7375   * @author     Sean Kerr <skerr@mojavi.org> 

  • trunk/src/logging/AgaviLoggerManager.class.php

    r1233 r1238  
    5454   * Initialize this AgaviLoggingManager. 
    5555   * 
     56   * @param      AgaviContext An AgaviContext instance. 
     57   * @param      array        An array of initialization parameters. 
     58   * 
    5659   * @throws     <b>AgaviInitializationException</b> If an error occurs while 
    57    *                                                 initializing a LoggingManager. 
     60   *                                                 initializing this instance. 
    5861   * 
    5962   * @author     David Zuelke <dz@bitxtender.com> 
    … …  
    124127   * @param      string A logger name. 
    125128   * 
    126    * @return     AgaviLogger A Logger, if the logger has been removed, else null. 
    127    * 
    128    * @throws     <b>AgaviLoggingException</b> If the logger name is default, which 
    129    *                                          cannot be removed. 
     129   * @return     AgaviLogger A Logger, if the logger has been removed, else  
     130   *                         null. 
     131   * 
     132   * @throws     <b>AgaviLoggingException</b> If the logger name is default, 
     133   *                                           which cannot be removed. 
    130134   * 
    131135   * @author     David Zuelke <dz@bitxtender.com> 

  • trunk/src/logging/AgaviLoggerMessage.class.php

    r1233 r1238  
    9494   * @param      int The priority level. 
    9595   * 
    96    * @return     Message 
     96   * @return     AgaviLoggerMessage 
    9797   * 
    9898   * @author     Bob Zoller <bob@agavi.org> 

  • trunk/src/logging/AgaviPassthruLoggerLayout.class.php

    r1233 r1238  
    1515 
    1616/** 
    17  * AgaviPassthruLoggerLayout is an AgaviLoggerLayout that will return the AgaviLoggerMessage text 
    18  * unaltered. 
     17 * AgaviPassthruLoggerLayout is an AgaviLoggerLayout that will return the  
     18 * AgaviLoggerMessage text unaltered. 
    1919 * 
    2020 * @package    agavi 
    … …  
    3232   * Format a message. 
    3333   * 
    34    * @param      AgaviLoggerMessage A AgaviLoggerMessage instance. 
     34   * @param      AgaviLoggerMessage An AgaviLoggerMessage instance. 
    3535   * 
    3636   * @return     string A formatted message. 

  • trunk/src/logging/AgaviRotatingFileLoggerAppender.class.php

    r1233 r1238  
    1414 
    1515/** 
    16  * AgaviRotatingFileLoggerAppender extends AgaviFileLoggerAppender by enabling per-day log files 
    17  * and removing unwanted old log files. 
     16 * AgaviRotatingFileLoggerAppender extends AgaviFileLoggerAppender by enabling  
     17 * per-day log files and removing unwanted old log files. 
    1818 * 
    1919 * <b>Required parameters:</b> 
    … …  
    2424 * 
    2525 * # <b>cycle</b>  - [7]                 - Number of log files to keep. 
    26  * # <b>prefix</b> - [core.app_name-] - Log filename prefix. 
     26 * # <b>prefix</b> - [core.app_name-]    - Log filename prefix. 
    2727 * # <b>suffix</b> - [.log]              - Log filename suffix. 
    2828 * 

  • trunk/src/renderer/AgaviPhpRenderer.class.php

    r962 r1238  
    8989   * 
    9090   * Note: This will return null because PHP itself has no engine reference. 
     91   * 
     92   * @return     null 
    9193   */ 
    9294  public function getEngine() 
    9395  { 
     96    return null; 
    9497  } 
    9598 

  • trunk/src/renderer/AgaviRenderer.class.php

    r1166 r1238  
    202202   * for this Renderer instance will be appended ("literal" false) or not (true) 
    203203   * 
    204    * @param      array The (decorator) template info given by the View. 
     204   * @param      array  The (decorator) template info given by the View. 
     205   * @param      string The extension prefix. 
     206   * @param      string The extension seperator. 
    205207   * 
    206208   * @return     string A template file name. 
    … …  
    391393   * It puts the returned data into the View (if appropriate) 
    392394   * 
     395   * @param      AgaviFilterChain The filter chain. 
     396   * @param      AgaviResponse    The response. 
     397   * 
    393398   * @author     David Zuelke <dz@bitxtender.com> 
    394399   * @since      0.11.0 
    … …  
    405410   * It puts the returned data into the View (if appropriate) 
    406411   * 
     412   * @param      AgaviFilterChain The filter chain. 
     413   * @param      AgaviResponse    The response. 
     414   * 
    407415   * @author     David Zuelke <dz@bitxtender.com> 
    408416   * @since      0.11.0 

  • trunk/src/renderer/AgaviXslRenderer.class.php

    r1063 r1238  
    149149   * @param      string The error's message. 
    150150   * 
    151    * @return     null 
    152    * 
    153151   * @author     Noah Fontes <impl@cynigram.com> 
    154152   * @since      0.11.0 
    … …  
    230228   * @param      DOMNode The element to append to. 
    231229   * @param      array The attributes to add to the XML document. 
    232    * 
    233    * @return     null 
    234230   * 
    235231   * @author     Noah Fontes <impl@cynigram.com> 
    … …  
    265261   * Retrieve the template engine associated with this view. 
    266262   * 
    267    * @return     XSLTProcessor A template engine instance used for this 
    268    *                           class. 
     263   * @return     XSLTProcessor A template engine instance used for this class. 
    269264   * 
    270265   * @author     Noah Fontes <impl@cynigram.com> 
    … …  
    279274  /** 
    280275   * Render the presentation to the Response. 
    281    * 
    282    * @return     null 
    283276   * 
    284277   * @author     Noah Fontes <impl@cynigram.com>