CVS: phpweather phpweather.php,1.22,1.23

[Martin G. <gim...@us...>]

Update of /cvsroot/phpweather/phpweather
In directory usw-pr-cvs1:/tmp/cvs-serv20409

Modified Files:
	phpweather.php 
Log Message:
Updated documentation.


Index: phpweather.php
===================================================================
RCS file: /cvsroot/phpweather/phpweather/phpweather.php,v
retrieving revision 1.22
retrieving revision 1.23
diff -u -3 -r1.22 -r1.23
--- phpweather.php	29 Mar 2002 13:51:55 -0000	1.22
+++ phpweather.php	13 Apr 2002 13:23:41 -0000	1.23
@@ -1,8 +1,23 @@
 <?php
 
-/* The location of this file defines the base directory */
+/**
+ * The base directory of the PHP Weather installation.
+ *
+ * When another file needs to include a file, this constant is used as
+ * the base directory. The location of this file defines the base
+ * directory
+ *
+ * @const PHPWEATHER_BASE_DIR The base directory. 
+ */
 define('PHPWEATHER_BASE_DIR', dirname(__FILE__));
+/* Due to a strange bug in PHPDoc, you must quote dirname(__FILE__)
+ * before you run PHPDoc! PHPDoc crashes with a segmentation fault on
+ * my system if the value is unquoted... */
 
+/**
+ * Require the parent class.
+ * @include The definition of data_retrieval.
+ */
 require_once(PHPWEATHER_BASE_DIR . '/data_retrieval.php');
 
 /**
@@ -12,7 +27,9 @@
  *
  * @author   Martin Geisler <gim...@gi...>
  * @version  $Id$
- * @see	$decoded_metar
+ * @package  PHP Weather
+ * @access   public
+ * @see	     $decoded_metar
  */
 class phpweather extends data_retrieval {