[pLog-svn] r1883 - in plog/branches/plog-1.0.1/class: . summary/dao

[oscar at devel.plogworld.net]

Author: oscar
Date: 2005-04-20 10:09:38 +0000 (Wed, 20 Apr 2005)
New Revision: 1883

Modified:
   plog/branches/plog-1.0.1/class/Doxyfile
   plog/branches/plog-1.0.1/class/summary/dao/summarystats.class.php
Log:
added the summary/dao/summarystats.class.php file to the documentation, and update its documentation a bit.


Modified: plog/branches/plog-1.0.1/class/Doxyfile
===================================================================
--- plog/branches/plog-1.0.1/class/Doxyfile	2005-04-19 20:27:50 UTC (rev 1882)
+++ plog/branches/plog-1.0.1/class/Doxyfile	2005-04-20 10:09:38 UTC (rev 1883)
@@ -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/ misc/ net/ data/ view/ plugin/ template/ action/
+INPUT                  = object/ dao/ logger/ gallery/ locale/ config/ file/ database/ data/forms security/ xml/ controller/ mail/ bayesian/ misc/ net/ data/ view/ plugin/ template/ action/ summary/dao/
 
 # 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/branches/plog-1.0.1/class/summary/dao/summarystats.class.php
===================================================================
--- plog/branches/plog-1.0.1/class/summary/dao/summarystats.class.php	2005-04-19 20:27:50 UTC (rev 1882)
+++ plog/branches/plog-1.0.1/class/summary/dao/summarystats.class.php	2005-04-20 10:09:38 UTC (rev 1883)
@@ -12,9 +12,14 @@
 	define( "SUMMARY_DEFAULT_ITEMS_PER_PAGE", 15 );
 
     /**
-     * implements some general methods that return some statistical
-     * data that is used in the summary.php script, and that is not
-     * very useful for anybody else
+     * This class implements a few methods that can be used to obtain the list of most recent blogs, posts, commets,
+     * most commented articles, etc. It is mainly used by the summary.php script but it can also be used by users
+     * wishing to integrate the summary page in their sites.
+     *
+     * @see BlogInfo
+     * @see Article
+     *
+     * \ingroup DAO	
      */
     class SummaryStats extends Model
     {