Minor - Adapting code comments to phpdoc

skala
Yannick Warnier 15 years ago
parent 9ac5a78e8c
commit e4d1cfef1f
  1. 8
      main/inc/lib/magpierss/rss_cache.inc
  2. 8
      main/inc/lib/magpierss/rss_fetch.inc
  3. 42
      main/inc/lib/magpierss/rss_parse.inc
  4. 16
      main/inc/lib/magpierss/rss_utils.inc

@ -1,5 +1,5 @@
<?php <?php
/* /**
* Project: MagpieRSS: a simple RSS integration tool * Project: MagpieRSS: a simple RSS integration tool
* File: rss_cache.inc, a simple, rolling(no GC), cache * File: rss_cache.inc, a simple, rolling(no GC), cache
* for RSS objects, keyed on URL. * for RSS objects, keyed on URL.
@ -13,9 +13,11 @@
* For questions, help, comments, discussion, etc., please join the * For questions, help, comments, discussion, etc., please join the
* Magpie mailing list: * Magpie mailing list:
* http://lists.sourceforge.net/lists/listinfo/magpierss-general * http://lists.sourceforge.net/lists/listinfo/magpierss-general
* * @package chamilo.include.rss
*/
/**
* @package chamilo.include.rss
*/ */
class RSSCache { class RSSCache {
public $BASE_CACHE = './cache'; // where the cache files are stored public $BASE_CACHE = './cache'; // where the cache files are stored
public $MAX_AGE = 3600; // when are files stale, default one hour public $MAX_AGE = 3600; // when are files stale, default one hour

@ -1,5 +1,5 @@
<?php <?php
/* /**
* Project: MagpieRSS: a simple RSS integration tool * Project: MagpieRSS: a simple RSS integration tool
* File: rss_fetch.inc, a simple functional interface * File: rss_fetch.inc, a simple functional interface
to fetching and parsing RSS files, via the to fetching and parsing RSS files, via the
@ -13,9 +13,11 @@
* For questions, help, comments, discussion, etc., please join the * For questions, help, comments, discussion, etc., please join the
* Magpie mailing list: * Magpie mailing list:
* magpierss-general@lists.sourceforge.net * magpierss-general@lists.sourceforge.net
* * @package chamilo.include.rss
*/
/**
* Code
*/ */
// Setup MAGPIE_DIR for use on hosts that don't include // Setup MAGPIE_DIR for use on hosts that don't include
// the current path in include_path. // the current path in include_path.
// with thanks to rajiv and smarty // with thanks to rajiv and smarty

@ -1,25 +1,26 @@
<?php <?php
/** /**
* Project: MagpieRSS: a simple RSS integration tool * Project: MagpieRSS: a simple RSS integration tool
* File: rss_parse.inc - parse an RSS or Atom feed * File: rss_parse.inc - parse an RSS or Atom feed
* return as a simple object. * return as a simple object.
* *
* Handles RSS 0.9x, RSS 2.0, RSS 1.0, and Atom 0.3 * Handles RSS 0.9x, RSS 2.0, RSS 1.0, and Atom 0.3
* *
* The lastest version of MagpieRSS can be obtained from: * The lastest version of MagpieRSS can be obtained from:
* http://magpierss.sourceforge.net * http://magpierss.sourceforge.net
* *
* For questions, help, comments, discussion, etc., please join the * For questions, help, comments, discussion, etc., please join the
* Magpie mailing list: * Magpie mailing list:
* magpierss-general@lists.sourceforge.net * magpierss-general@lists.sourceforge.net
* *
* @author Kellan Elliott-McCrea <kellan@protest.net> * @author Kellan Elliott-McCrea <kellan@protest.net>
* @version 0.7a * @version 0.7a
* @license GPL * @license GPL
* * @package chamilo.include.rss
*/ */
/**
* Code
*/
define('RSS', 'RSS'); define('RSS', 'RSS');
define('ATOM', 'Atom'); define('ATOM', 'Atom');
@ -30,6 +31,7 @@ require_once (MAGPIE_DIR . 'rss_utils.inc');
* *
* see: rss_fetch.inc for a simpler interface with integrated caching support * see: rss_fetch.inc for a simpler interface with integrated caching support
* *
* @package chamilo.include.rss
*/ */
class MagpieRSS { class MagpieRSS {
public $parser; public $parser;

@ -1,5 +1,5 @@
<?php <?php
/* /**
* Project: MagpieRSS: a simple RSS integration tool * Project: MagpieRSS: a simple RSS integration tool
* File: rss_utils.inc, utility methods for working with RSS * File: rss_utils.inc, utility methods for working with RSS
* Author: Kellan Elliott-McCrea <kellan@protest.net> * Author: Kellan Elliott-McCrea <kellan@protest.net>
@ -12,16 +12,16 @@
* For questions, help, comments, discussion, etc., please join the * For questions, help, comments, discussion, etc., please join the
* Magpie mailing list: * Magpie mailing list:
* magpierss-general@lists.sourceforge.net * magpierss-general@lists.sourceforge.net
* @package chamilo.include.rss
*/ */
/*======================================================================*\ /**
Function: parse_w3cdtf * Function: parse_w3cdtf
Purpose: parse a W3CDTF date into unix epoch * Purpose: parse a W3CDTF date into unix epoch
*
NOTE: http://www.w3.org/TR/NOTE-datetime * NOTE: http://www.w3.org/TR/NOTE-datetime
\*======================================================================*/ */
function parse_w3cdtf ( $date_str ) { function parse_w3cdtf ( $date_str ) {
# regex to match wc3dtf # regex to match wc3dtf

Loading…
Cancel
Save