-In an effort to document our code, we've started using code comments and [http://www.stack.nl/~dimitri/doxygen/|Doxygen (http://www.stack.nl/~dimitri/doxygen/)]. The Doxygen config file can be found under ''yourtikiproinstall''__/doc/doxygen.cfg__.
|
+__current APIDocumentation is in pdpDocumentor format, the same as used for Smarty itself - these notes will be brought in line once work is complete !__ |
+ |
+In an effort to document our code, we've started using code comments and [http://www.stack.nl/~dimitri/doxygen/|Doxygen (http://www.stack.nl/~dimitri/doxygen/)]. To browse the API documentation, visit __http://your.bitweaver.install/doc/html/__. |
+The Doxygen config file can be found under __''yourbitweaverinstall''/doc/doxygen.cfg__. |
+ |
{maketoc}
|
-This page is to help new (and old) Tikipro developers understand how and why we do things the way we do - for API documentation anyway.
|
+This page is to help new (and old) bitweaver developers understand how and why we do things the way we do - for API documentation anyway. |
|
!Class Doc Comments
|
Below are some examples of code comments. Please use them as templates - and any improvements should be posted back here.
|
!!Copyright Notice
|
-{CODE()}/**
|
-* $Header: /cvsroot/tikipro/_p_tp_kernel/cache_lib.php,v 1.1.2.3 2004/07/01 12:57:15 wolff_borg Exp $
|
+{CODE source=php}/** |
+* $Header: /cvsroot/bitweaver/_p_tp_kernel/cache_lib.php,v 1.1.2.3 2004/07/01 12:57:15 wolff_borg Exp $ |
*
|
-* Copyright (c) 2004 tikipro.org
|
+* Copyright (c) 2004 bitweaver.org |
* Copyright (c) 2003 tikwiki.org
|
* Copyright (c) 2002-2003, Luis Argerich, Garland Foster, Eduardo Polidor, et. al.
|
* All Rights Reserved. See copyright.txt for details and a complete list of authors.
|
+ |
* Licensed under the GNU LESSER GENERAL PUBLIC LICENSE. See license.txt for details
|
*
|
* $Id: cache_lib.php,v 1.1.2.3 2004/07/01 12:57:15 wolff_borg Exp $
|
-*/{CODE}
|
-This is our copyright notice. Everything with a __$__ tag eg ''$Header: ... $'' is dynamically updated by CVS. This should be included at the beginning of every file in the Tikipro CVS source tree.
|
+*/{/CODE} |
+This is our copyright notice. Everything with a __$__ tag eg ''$Header: ... $'' is dynamically updated by CVS. This should be included at the beginning of every file in the bitweaver CVS source tree. |
|
!!Class Description
|
-{CODE()}/**
|
+{CODE source=php}/** |
* A basic library to handle caching of some Tiki Objects. Usage is simple and feel free to improve it.
|
*
|
* Currently used to cache user permissions only. Could be used to store blobs to files and other static
|
* database intensive queries.
|
*
|
* @date created 2003/11/25
|
-* @author lrargerich <lrargerich@yahoo.com>
|
+* @author lrargerich <lrargerich@yahoo.com> |
*
|
* @version $Revision: 1.1.2.4 $ $Date: 2004/07/03 02:21:19 $ $Author: wolff_borg $
|
-* @package Kernel
|
+* |
* @class Cachelib
|
* @todo Need to implement in more places
|
*/
|
class Cachelib
|
{
|
-...{CODE}
|
+...}{/CODE} |
So quick explanation. The first two paragraphs are just a description of the class and what it does. Its wise to included where it is used, and if possible point to a code example if its difficult to use.
|
|
!!Doxygen Commands
|