docs/default.css
[roojs1] / docs / symbols / src / Roo_doc_Param.js.html
index b2e9e49..a428b2d 100644 (file)
@@ -7,9 +7,9 @@
  * @class Roo.doc.Param
  * @extends Roo.bootstrap.Component
  * Param Element class
- * @cfg {bool} is_optional 
+ * @cfg {bool} is_optional is the argument optional
  * @cfg {String} type  argument type
- * @cfg {String} name
+ * @cfg {String} name name of the parameter
  * @cfg {String} desc  short description
  * @cfg {String} defaultvalue default value
  * 
@@ -34,6 +34,7 @@
         
         </span><span class="jsdoc-comment">//?? this is the synopsis type....
         
+        </span><span class="jsdoc-keyword">var </span><span class="jsdoc-var">desc </span><span class="jsdoc-syntax">= </span><span class="jsdoc-var">Roo.Markdown.toHtml</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">this.desc</span><span class="jsdoc-syntax">);
         
         </span><span class="jsdoc-keyword">if </span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">this.parent</span><span class="jsdoc-syntax">()</span><span class="jsdoc-var">.stype </span><span class="jsdoc-syntax">== </span><span class="jsdoc-string">'parameter'</span><span class="jsdoc-syntax">) {
             
@@ -48,7 +49,7 @@
                                 </span><span class="jsdoc-var">tag</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'code'</span><span class="jsdoc-syntax">,
                                 </span><span class="jsdoc-var">html </span><span class="jsdoc-syntax">: </span><span class="jsdoc-var">this.type </span><span class="jsdoc-syntax">+ </span><span class="jsdoc-string">' ' </span><span class="jsdoc-syntax">+ </span><span class="jsdoc-var">this.name
                             </span><span class="jsdoc-syntax">},
-                            </span><span class="jsdoc-var">this.desc
+                            </span><span class="jsdoc-var">desc
                         </span><span class="jsdoc-syntax">]
                     }
                 ]
@@ -64,7 +65,7 @@
                             </span><span class="jsdoc-var">tag</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'code'</span><span class="jsdoc-syntax">,
                             </span><span class="jsdoc-var">html </span><span class="jsdoc-syntax">: </span><span class="jsdoc-var">this.type
                         </span><span class="jsdoc-syntax">},
-                        </span><span class="jsdoc-var">this.desc
+                        </span><span class="jsdoc-var">desc
                     </span><span class="jsdoc-syntax">]
                 };
                 
         </span><span class="jsdoc-keyword">var </span><span class="jsdoc-var">cfg </span><span class="jsdoc-syntax">={
             </span><span class="jsdoc-var">tag</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'span'</span><span class="jsdoc-syntax">,
             </span><span class="jsdoc-var">cn </span><span class="jsdoc-syntax">: [
-                </span><span class="jsdoc-var">is_optional </span><span class="jsdoc-syntax">? </span><span class="jsdoc-string">'[' </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">''</span><span class="jsdoc-syntax">,
+                </span><span class="jsdoc-var">this.is_optional </span><span class="jsdoc-syntax">? </span><span class="jsdoc-string">'[' </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">''</span><span class="jsdoc-syntax">,
                 </span><span class="jsdoc-var">this.type</span><span class="jsdoc-syntax">,
                 </span><span class="jsdoc-string">' '</span><span class="jsdoc-syntax">,
-                </span><span class="jsdoc-var">this.name</span><span class="jsdoc-syntax">,
+                {
+                    </span><span class="jsdoc-var">tag </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'b'</span><span class="jsdoc-syntax">,
+                    </span><span class="jsdoc-var">html </span><span class="jsdoc-syntax">: </span><span class="jsdoc-var">this.name
+                </span><span class="jsdoc-syntax">},
                 </span><span class="jsdoc-var">this.defaultvalue </span><span class="jsdoc-syntax">== </span><span class="jsdoc-string">'' </span><span class="jsdoc-syntax">? </span><span class="jsdoc-string">'' </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">' = '</span><span class="jsdoc-syntax">,
                 </span><span class="jsdoc-var">this.defaultvalue</span><span class="jsdoc-syntax">,
+                </span><span class="jsdoc-var">this.is_optional </span><span class="jsdoc-syntax">? </span><span class="jsdoc-string">']' </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">''</span><span class="jsdoc-syntax">,
                 </span><span class="jsdoc-string">',' </span><span class="jsdoc-comment">// not really.. but let's do it anyway...
             </span><span class="jsdoc-syntax">]
         };
         
        
         </span><span class="jsdoc-keyword">return </span><span class="jsdoc-var">cfg</span><span class="jsdoc-syntax">;
+    },
+    </span><span class="jsdoc-var">getAutoCreateParamSection </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">()
+    {
+        </span><span class="jsdoc-keyword">var </span><span class="jsdoc-var">desc </span><span class="jsdoc-syntax">= </span><span class="jsdoc-var">Roo.Markdown.toHtml</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">this.desc</span><span class="jsdoc-syntax">);
+        
+      
+        </span><span class="jsdoc-keyword">return </span><span class="jsdoc-syntax">{
+               </span><span class="jsdoc-var">tag </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'li'</span><span class="jsdoc-syntax">,
+               </span><span class="jsdoc-var">cn </span><span class="jsdoc-syntax">: [
+                   {
+                       </span><span class="jsdoc-var">tag </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'p'</span><span class="jsdoc-syntax">,
+                       </span><span class="jsdoc-var">cls</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'para'</span><span class="jsdoc-syntax">,
+                       </span><span class="jsdoc-var">cn </span><span class="jsdoc-syntax">: [
+                           {
+                               </span><span class="jsdoc-var">tag</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'code'</span><span class="jsdoc-syntax">,
+                               </span><span class="jsdoc-var">html </span><span class="jsdoc-syntax">: </span><span class="jsdoc-var">this.type </span><span class="jsdoc-syntax">+ </span><span class="jsdoc-string">' ' </span><span class="jsdoc-syntax">+ </span><span class="jsdoc-var">this.name
+                           </span><span class="jsdoc-syntax">},
+                           </span><span class="jsdoc-var">desc
+                       </span><span class="jsdoc-syntax">]
+                   }
+               ]
+           };
+        
+        
     }
+