History of APIDocumentation

Differences from version 18 to 19



@@ -9,7 +9,7 @@

 !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()}/**
+{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 bitweaver.org

@@ -20,11 +20,11 @@

 * 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}
+*/{/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

@@ -40,7 +40,7 @@

 */
 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

@@ -84,20 +84,21 @@

 Used to describe a test case - not really sure how we would use this yet.
 
 !!Variable Description
-{CODE()} /**
+{CODE source=php} /**
  * Used to store the directory used to store the cache files.
  */
- var $_folder;{CODE}
+ var $_folder;{/CODE}
 For variable, just include a line to explain its use.
 
 !!Function Description
-{CODE()} /**
+{CODE source=php} /**
  * Used to retrieve an object if cached.
  * @param key the unique identifier used to retrieve the cached item
  * @return object if cached object exists
  */
  function getCached($key)
- {{CODE}
+ {...
+ }{/CODE}
 
 !!!@param
 [http://www.stack.nl/~dimitri/doxygen/commands.html#cmdparam]
Page History
Date/CommentUserIPVersion
11 Mar 2006 (11:59 UTC)
Uwe Zimmermann87.96.133.21919
Current • Source
Lester Caine81.138.11.13618
View • Compare • Difference • Source
Stephan Borg66.93.240.20417
View • Compare • Difference • Source
Stephan Borg218.214.1.11316
View • Compare • Difference • Source
Stephan Borg218.214.1.11315
View • Compare • Difference • Source
Stephan Borg218.214.1.11314
View • Compare • Difference • Source
Stephan Borg218.214.1.11313
View • Compare • Difference • Source
Stephan Borg218.214.1.11312
View • Compare • Difference • Source
Stephan Borg218.214.1.11310
View • Compare • Difference • Source
Stephan Borg218.214.1.1139
View • Compare • Difference • Source
Stephan Borg218.214.1.1137
View • Compare • Difference • Source
Stephan Borg218.214.1.1136
View • Compare • Difference • Source
Stephan Borg218.214.1.1133
View • Compare • Difference • Source
Stephan Borg218.214.1.1132
View • Compare • Difference • Source