[phpwebapp-commits] CVS: web_app/boxes/webnotes webnotes.php,1.1,1.2 DB.php,1.1,1.2

[Dashamir H. <das...@us...>]

Update of /cvsroot/phpwebapp/web_app/boxes/webnotes
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv25443/boxes/webnotes

Modified Files:
	webnotes.php DB.php 
Log Message:
automatic code documentation generation


Index: webnotes.php
===================================================================
RCS file: /cvsroot/phpwebapp/web_app/boxes/webnotes/webnotes.php,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -d -r1.1 -r1.2
*** webnotes.php	26 Oct 2005 14:32:16 -0000	1.1
--- webnotes.php	2 Nov 2005 15:17:54 -0000	1.2
***************
*** 24,27 ****
--- 24,39 ----
  include_once dirname(__FILE__).'/DB.php';
  
+ /**
+  * The webbox 'webnotes' can be used to append comments or notes
+  * to documentation pages or to other web pages. 
+  * This component uses the database; the connection parameters are at 
+  * 'templates/docbook/view/webnotes/DB.php'.
+  * The application or the webbox that includes it should also give a
+  * value to the state variable 'webnotes->page_id', which is used to
+  * select from the database the notes that will be displayed.
+  *
+  * @package     components
+  * @subpackage  webnotes
+  */
  class webnotes extends WebObject
  {

Index: DB.php
===================================================================
RCS file: /cvsroot/phpwebapp/web_app/boxes/webnotes/DB.php,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -d -r1.1 -r1.2
*** DB.php	26 Oct 2005 14:32:16 -0000	1.1
--- DB.php	2 Nov 2005 15:17:54 -0000	1.2
***************
*** 1,3 ****
--- 1,8 ----
  <?php
+ /**
+  * @package     components
+  * @subpackage  webnotes
+  */
+ 
  //connection parameters
  $host   = 'localhost';