[pLog-svn] r1634 - in plog/trunk/class: . misc
oscar at devel.plogworld.net
oscar at devel.plogworld.net
Tue Mar 29 17:42:20 GMT 2005
Author: oscar
Date: 2005-03-29 17:42:20 +0000 (Tue, 29 Mar 2005)
New Revision: 1634
Modified:
plog/trunk/class/Doxyfile
plog/trunk/class/misc/glob.class.php
plog/trunk/class/misc/osdetect.class.php
plog/trunk/class/misc/version.class.php
Log:
more documented classes
Modified: plog/trunk/class/Doxyfile
===================================================================
--- plog/trunk/class/Doxyfile 2005-03-29 17:27:55 UTC (rev 1633)
+++ plog/trunk/class/Doxyfile 2005-03-29 17:42:20 UTC (rev 1634)
@@ -416,7 +416,7 @@
# directories like "/usr/src/myproject". Separate the files or directories
# with spaces.
-INPUT = object/ dao/ logger/ gallery/ locale/ config/ file/ database/ data/forms security/ xml/ controller/ mail/ bayesian/
+INPUT = object/ dao/ logger/ gallery/ locale/ config/ file/ database/ data/forms security/ xml/ controller/ mail/ bayesian/ misc/
# If the value of the INPUT tag contains directories, you can use the
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
Modified: plog/trunk/class/misc/glob.class.php
===================================================================
--- plog/trunk/class/misc/glob.class.php 2005-03-29 17:27:55 UTC (rev 1633)
+++ plog/trunk/class/misc/glob.class.php 2005-03-29 17:42:20 UTC (rev 1634)
@@ -1,13 +1,17 @@
<?php
/**
- * @package misc
+ * \defgroup Misc
+ *
+ * Miscellaneous classes that did not fit anywhere
*/
include_once( PLOG_CLASS_PATH."class/object/object.class.php" );
/**
+ * \ingroup Misc
+ *
* Alternative implementation of the glob() function, since the latter is only
* available in php versions 4.3 or higher and many many hosts have not updated
* yet.
@@ -17,7 +21,8 @@
* The class is capable of detecting the version of php and using the native (and probably
* faster) version instead of the custom one.
*/
- class Glob extends Object {
+ class Glob extends Object
+ {
/**
* This function checks wether we're running a version of php at least or newer than
Modified: plog/trunk/class/misc/osdetect.class.php
===================================================================
--- plog/trunk/class/misc/osdetect.class.php 2005-03-29 17:27:55 UTC (rev 1633)
+++ plog/trunk/class/misc/osdetect.class.php 2005-03-29 17:42:20 UTC (rev 1634)
@@ -1,18 +1,16 @@
<?php
- /**
- * @package misc
- */
-
-
include_once( PLOG_CLASS_PATH."class/object/object.class.php" );
/**
+ * \ingroup Misc
+ *
* Operating system detection functions. This class provides a bunch of functions in order to detect
* on which operating system our php parser is running. Please bear in mind that this has not been
* thoroughly tested and that at the moment it only provides detection for windows and linux.
*/
- class OsDetect extends Object {
+ class OsDetect extends Object
+ {
/**
* Returns the OS string returned by php_uname
@@ -57,4 +55,4 @@
return false;
}
}
-?>
+?>
\ No newline at end of file
Modified: plog/trunk/class/misc/version.class.php
===================================================================
--- plog/trunk/class/misc/version.class.php 2005-03-29 17:27:55 UTC (rev 1633)
+++ plog/trunk/class/misc/version.class.php 2005-03-29 17:42:20 UTC (rev 1634)
@@ -1,10 +1,5 @@
<?php
- /**
- * @package misc
- */
-
-
include_once( PLOG_CLASS_PATH."class/object/object.class.php" );
include_once( PLOG_CLASS_PATH."class/file/file.class.php" );
@@ -14,7 +9,9 @@
define( "DEFAULT_VERSION_FILE", PLOG_CLASS_PATH . "version.php" );
/**
- * Returns the version of pLog we're running.
+ * \ingroup Misc
+ *
+ * Returns the current version of plog as well as a link to the project page
*/
class Version extends Object
{
@@ -48,4 +45,4 @@
return PLOG_PROJECT_PAGE;
}
}
-?>
+?>
\ No newline at end of file
More information about the pLog-svn
mailing list