[Sungrazr-svn] [113] Sungrazr_Docs_Phpdoc: [CHG] now expects (required) instead of 'required'.

[cl...@killersoft.com]

Revision

113

Author

clay

Date

2008-02-10 11:55:19 -0800 (Sun, 10 Feb 2008)

Log Message

Sungrazr_Docs_Phpdoc: [CHG] now expects (required) instead of 'required'. Also added support for @restricted element

Modified Paths

• trunk/Sungrazr/Docs/Phpdoc.php

Diff

Modified: trunk/Sungrazr/Docs/Phpdoc.php (112 => 113)

--- trunk/Sungrazr/Docs/Phpdoc.php	2008-02-10 03:59:49 UTC (rev 112)
+++ trunk/Sungrazr/Docs/Phpdoc.php	2008-02-10 19:55:19 UTC (rev 113)
@@ -38,6 +38,21 @@
         }
         $this->_info['supports'] = $methods;
     }   
+
+    /**
+     * 
+     * Parses one @restricted line into $this->_info. Allows documentation to
+     * specifiy that authentication is required to call this method.
+     * 
+     * @param string $line The block line.
+     * 
+     * @return void
+     * 
+     */
+    public function parseRestricted($line)
+    {
+        $this->_info['restricted'] = true;
+    }   
     
     /**
      * 
@@ -62,7 +77,7 @@
      * 
      * @return void
      * 
-     * @todo Consider re-factoring to support deeper levels than subsubparam     
+     * @todo Consider re-factoring into recursive method to support deeper levels than subsubparam     
      * 
      */
     public function parseSubparam($line)
@@ -124,14 +139,13 @@
         $info['summ'] = $summ;
         
         // is this sub parameter required?
-        if (substr($summ, 0, 8) == 'required') {
+        if (substr($summ, 0, 10) == '(required)') {
             $info['required'] = true;
-            $info['summ'] = substr($summ, 9);
+            $info['summ'] = substr($summ, 11);
         }
         
         if (! empty($subsubparam)) {
-            $info['name'] = $subsubparam;
-            $this->_info['param'][$param]['param'][$subparam]['param'][] = $info;
+            $this->_info['param'][$param]['param'][$subparam]['param'][$subsubparam] = $info;
         } else {
             $this->_info['param'][$param]['param'][$subparam] = $info;
         }