[wp-hackers] [PATCH] Documentation

[Rich Bowen]

Example documentation patch. Note, this is just one example, and not one
of the most useful ones - just one of the simplest ones. More complex
examples would also contain a simple explanation of the return value.


Index: functions.php
===================================================================
--- functions.php       (revision 3535)
+++ functions.php       (working copy)
@@ -47,6 +47,9 @@
        return $j;
 }

+/** current_time( $type = ('mysql'|'timestamp')
+*               [ , $gmt = (true|false) ] )
+*/
 function current_time($type, $gmt = 0) {
        switch ($type) {



-- 
Rich Bowen
rbowen at rcbowen.com