git.roojs.org Git - roojs1/blob - docs/symbols/src/roojs-doc-debug.js.html

   1 <html><head><title>../roojs1/roojs-doc-debug.js</title><link rel="stylesheet" type="text/css" href="../../../css/highlight-js.css"/></head><body class="highlightpage"><code class="jsdoc-pretty"><span class="jsdoc-comment">/*
   2  * - LGPL
   3  *
   4  *  Documentation - designed to generate HTML+Docbook!?!
   5  */
   6 </span><span class="jsdoc-var">Roo.doc </span><span class="jsdoc-syntax">= </span><span class="jsdoc-var">Roo.doc </span><span class="jsdoc-syntax">|| {};
   7
   8 </span><span class="jsdoc-comment">/**
   9  * @class Roo.doc.Entry
  10  * @extends Roo.bootstrap.Component
  11  * Entry Element class - describes a method etc...
  12  * @cfg name {String} name of method
  13  * @cfg purpose {String} short description of method.
  14  *
  15  * @constructor
  16  * Create a new E
  17  * @param {Object} config The config object
  18  */
  19
  20
  21
  22 </span><span class="jsdoc-var">Roo.doc.Entry  </span><span class="jsdoc-syntax">= </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">config</span><span class="jsdoc-syntax">){
  23     </span><span class="jsdoc-var">Roo.doc.Entry.superclass.constructor.call</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">this</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">config</span><span class="jsdoc-syntax">);
  24     </span><span class="jsdoc-comment">//this.el = Roo.get(document.body);
  25     </span><span class="jsdoc-keyword">var </span><span class="jsdoc-var">body </span><span class="jsdoc-syntax">= </span><span class="jsdoc-var">Roo.get</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">document.body</span><span class="jsdoc-syntax">);
  26     </span><span class="jsdoc-var">body.attr</span><span class="jsdoc-syntax">({
  27         </span><span class="jsdoc-var">leftmargin </span><span class="jsdoc-syntax">: 0,
  28         </span><span class="jsdoc-var">marginwidth </span><span class="jsdoc-syntax">: 0,
  29         </span><span class="jsdoc-var">topmargin </span><span class="jsdoc-syntax">: 0,
  30         </span><span class="jsdoc-var">marginheight </span><span class="jsdoc-syntax">: 0,
  31         </span><span class="jsdoc-var">offset </span><span class="jsdoc-syntax">: 0
  32     });
  33
  34
  35     </span><span class="jsdoc-comment">// call onRender once... and block next call...?
  36     </span><span class="jsdoc-var">this.onRender</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">body</span><span class="jsdoc-syntax">);
  37     </span><span class="jsdoc-var">this.el </span><span class="jsdoc-syntax">= </span><span class="jsdoc-var">body</span><span class="jsdoc-syntax">;
  38     </span><span class="jsdoc-comment">//this.onRender = function() { };
  39
  40 </span><span class="jsdoc-syntax">};
  41
  42 </span><span class="jsdoc-var">Roo.doc.Entry._calls </span><span class="jsdoc-syntax">= 0;
  43
  44 </span><span class="jsdoc-var">Roo.extend</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">Roo.doc.Entry</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">Roo.bootstrap.Component</span><span class="jsdoc-syntax">,  {
  45
  46
  47     </span><span class="jsdoc-var">name </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">''</span><span class="jsdoc-syntax">,
  48     </span><span class="jsdoc-var">purpose </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">''</span><span class="jsdoc-syntax">,
  49
  50     </span><span class="jsdoc-var">getAutoCreate </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(){
  51
  52         </span><span class="jsdoc-keyword">var </span><span class="jsdoc-var">cfg </span><span class="jsdoc-syntax">={
  53             </span><span class="jsdoc-var">cls </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'refentry'</span><span class="jsdoc-syntax">,
  54             </span><span class="jsdoc-var">cn </span><span class="jsdoc-syntax">: [
  55                 {
  56                     </span><span class="jsdoc-var">tag</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'h1'</span><span class="jsdoc-syntax">,
  57                     </span><span class="jsdoc-var">cls</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'refname'</span><span class="jsdoc-syntax">,
  58                     </span><span class="jsdoc-var">html </span><span class="jsdoc-syntax">: </span><span class="jsdoc-var">this.name
  59                 </span><span class="jsdoc-syntax">},
  60                 {
  61                     </span><span class="jsdoc-var">cls</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'refnamediv'</span><span class="jsdoc-syntax">,
  62                     </span><span class="jsdoc-var">html </span><span class="jsdoc-syntax">: </span><span class="jsdoc-var">this.purpose
  63                 </span><span class="jsdoc-syntax">}
  64             ]
  65         };
  66
  67
  68
  69
  70         </span><span class="jsdoc-keyword">return </span><span class="jsdoc-var">cfg</span><span class="jsdoc-syntax">;
  71     },
  72
  73     </span><span class="jsdoc-var">addxtype </span><span class="jsdoc-syntax">:   </span><span class="jsdoc-keyword">function </span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">tree</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">cntr</span><span class="jsdoc-syntax">)
  74     {
  75         </span><span class="jsdoc-keyword">return </span><span class="jsdoc-var">this.addxtypeChild</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">tree</span><span class="jsdoc-syntax">,</span><span class="jsdoc-var">cntr</span><span class="jsdoc-syntax">);
  76     },
  77
  78     </span><span class="jsdoc-var">onRender </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">ct</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">position</span><span class="jsdoc-syntax">)
  79     {
  80
  81         </span><span class="jsdoc-var">Roo.doc.Entry._calls</span><span class="jsdoc-syntax">++;
  82         </span><span class="jsdoc-keyword">if </span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">Roo.doc.Entry._calls </span><span class="jsdoc-syntax">&gt; 1 || !</span><span class="jsdoc-var">ct</span><span class="jsdoc-syntax">) {
  83             </span><span class="jsdoc-keyword">return</span><span class="jsdoc-syntax">;
  84         }
  85
  86     </span><span class="jsdoc-comment">// call onRender once... and block next call...?
  87
  88         </span><span class="jsdoc-var">Roo.bootstrap.Component.prototype.onRender.call</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">this</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">ct</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">position</span><span class="jsdoc-syntax">);
  89     }
  90
  91 });
  92
  93
  94
  95  </span><span class="jsdoc-comment">/*
  96  * - LGPL
  97  *
  98  */
  99
 100 /**
 101  * @class Roo.doc.Example
 102  * @extends Roo.bootstrap.Component
 103  * Example Element class
 104  * @cfg {String} title short title describing example
 105  * @cfg {String} lang (php|txt|sql) section type.
 106  * @cfg {String} code  example code
 107  * @cfg {String} output The expected output from the code
 108  *
 109  *
 110  * @constructor
 111  * Create a new Synopsis
 112  * @param {Object} config The config object
 113  */
 114
 115 </span><span class="jsdoc-var">Roo.doc.Example </span><span class="jsdoc-syntax">= </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">config</span><span class="jsdoc-syntax">){
 116     </span><span class="jsdoc-var">Roo.doc.Example.superclass.constructor.call</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">this</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">config</span><span class="jsdoc-syntax">);
 117 };
 118
 119 </span><span class="jsdoc-var">Roo.extend</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">Roo.doc.Example</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">Roo.bootstrap.Component</span><span class="jsdoc-syntax">,  {
 120
 121     </span><span class="jsdoc-var">title </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">''</span><span class="jsdoc-syntax">,
 122     </span><span class="jsdoc-var">lang</span><span class="jsdoc-syntax">:   </span><span class="jsdoc-string">'php'</span><span class="jsdoc-syntax">,
 123     </span><span class="jsdoc-var">code </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">''</span><span class="jsdoc-syntax">,
 124     </span><span class="jsdoc-var">output </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">''</span><span class="jsdoc-syntax">,
 125
 126     </span><span class="jsdoc-var">getAutoCreate </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(){
 127
 128         </span><span class="jsdoc-comment">// no colour highlighting in here....
 129
 130         </span><span class="jsdoc-keyword">var </span><span class="jsdoc-var">cfg </span><span class="jsdoc-syntax">={
 131             </span><span class="jsdoc-var">cls </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'panel panel-info'</span><span class="jsdoc-syntax">,
 132             </span><span class="jsdoc-var">cn </span><span class="jsdoc-syntax">: [
 133                 {
 134                     </span><span class="jsdoc-var">cls </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'panel-heading'</span><span class="jsdoc-syntax">,
 135                     </span><span class="jsdoc-var">html </span><span class="jsdoc-syntax">: </span><span class="jsdoc-var">this.title
 136                 </span><span class="jsdoc-syntax">},
 137                 {
 138                     </span><span class="jsdoc-var">cls </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'panel-body'</span><span class="jsdoc-syntax">,
 139                     </span><span class="jsdoc-var">cn </span><span class="jsdoc-syntax">: [
 140                         {
 141                             </span><span class="jsdoc-var">tag</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'pre'</span><span class="jsdoc-syntax">,
 142                             </span><span class="jsdoc-var">cls </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'lang-' </span><span class="jsdoc-syntax">+ </span><span class="jsdoc-var">this.lang</span><span class="jsdoc-syntax">,
 143                             </span><span class="jsdoc-var">html </span><span class="jsdoc-syntax">:  </span><span class="jsdoc-var">String.format</span><span class="jsdoc-syntax">(</span><span class="jsdoc-string">'{0}'</span><span class="jsdoc-syntax">,</span><span class="jsdoc-var">this.code</span><span class="jsdoc-syntax">)</span><span class="jsdoc-var">.replace</span><span class="jsdoc-syntax">(/\n/g, </span><span class="jsdoc-string">'&lt;br/&gt;'</span><span class="jsdoc-syntax">)
 144                         }
 145                     ]
 146                 }
 147             ]
 148         };
 149
 150         </span><span class="jsdoc-keyword">if </span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">this.output</span><span class="jsdoc-syntax">) {
 151             </span><span class="jsdoc-var">cfg.cn.push</span><span class="jsdoc-syntax">(
 152
 153                 {
 154                     </span><span class="jsdoc-var">cls </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'panel-footer'</span><span class="jsdoc-syntax">,
 155                     </span><span class="jsdoc-var">cn </span><span class="jsdoc-syntax">: {
 156                         </span><span class="jsdoc-var">tag</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'code'</span><span class="jsdoc-syntax">,
 157                         </span><span class="jsdoc-var">html </span><span class="jsdoc-syntax">:  </span><span class="jsdoc-var">String.format</span><span class="jsdoc-syntax">(</span><span class="jsdoc-string">'{0}'</span><span class="jsdoc-syntax">,</span><span class="jsdoc-var">this.output</span><span class="jsdoc-syntax">)</span><span class="jsdoc-var">.replace</span><span class="jsdoc-syntax">(/\n/g, </span><span class="jsdoc-string">'&lt;br/&gt;'</span><span class="jsdoc-syntax">)
 158                     }
 159                 }
 160
 161
 162             );
 163         }
 164
 165
 166
 167         </span><span class="jsdoc-keyword">return </span><span class="jsdoc-var">cfg</span><span class="jsdoc-syntax">;
 168     }
 169
 170
 171
 172
 173 });
 174
 175
 176
 177  </span><span class="jsdoc-comment">/*
 178  * - LGPL
 179  *
 180  */
 181
 182 /**
 183  * @class Roo.doc.Para
 184  * @extends Roo.bootstrap.Component
 185  * Param Element class
 186  * @cfg {String} html
 187  *
 188  * @constructor
 189  * Create a new Paragraph
 190  * @param {Object} config The config object
 191  */
 192
 193 </span><span class="jsdoc-var">Roo.doc.Para </span><span class="jsdoc-syntax">= </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">config</span><span class="jsdoc-syntax">){
 194     </span><span class="jsdoc-var">Roo.doc.Para.superclass.constructor.call</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">this</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">config</span><span class="jsdoc-syntax">);
 195 };
 196
 197 </span><span class="jsdoc-var">Roo.extend</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">Roo.doc.Para</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">Roo.bootstrap.Component</span><span class="jsdoc-syntax">,  {
 198
 199     </span><span class="jsdoc-var">html </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">''</span><span class="jsdoc-syntax">,
 200     </span><span class="jsdoc-var">getAutoCreate </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(){
 201
 202         </span><span class="jsdoc-comment">//?? this is the synopsis type....
 203
 204         // this is not very fancy...
 205
 206         </span><span class="jsdoc-keyword">var </span><span class="jsdoc-var">cfg </span><span class="jsdoc-syntax">={
 207             </span><span class="jsdoc-var">tag</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'p'</span><span class="jsdoc-syntax">,
 208             </span><span class="jsdoc-var">cls</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'para'</span><span class="jsdoc-syntax">,
 209             </span><span class="jsdoc-var">html </span><span class="jsdoc-syntax">: </span><span class="jsdoc-var">this.html
 210         </span><span class="jsdoc-syntax">};
 211
 212         </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">.is_list</span><span class="jsdoc-syntax">) {
 213             </span><span class="jsdoc-keyword">return </span><span class="jsdoc-syntax">{
 214                 </span><span class="jsdoc-var">tag</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'li'</span><span class="jsdoc-syntax">,
 215                 </span><span class="jsdoc-var">cls </span><span class="jsdoc-syntax">: </span><span class="jsdoc-var">listitme</span><span class="jsdoc-syntax">,
 216                 </span><span class="jsdoc-var">cn </span><span class="jsdoc-syntax">: [ </span><span class="jsdoc-var">cfg </span><span class="jsdoc-syntax">]
 217             };
 218
 219         }
 220
 221         </span><span class="jsdoc-keyword">return </span><span class="jsdoc-var">cfg</span><span class="jsdoc-syntax">;
 222     }
 223
 224
 225
 226
 227
 228
 229 });
 230
 231
 232
 233  </span><span class="jsdoc-comment">/*
 234  * - LGPL
 235  *
 236  */
 237
 238 /**
 239  * @class Roo.doc.Param
 240  * @extends Roo.bootstrap.Component
 241  * Param Element class
 242  * @cfg {bool} is_optional is the argument optional
 243  * @cfg {String} type  argument type
 244  * @cfg {String} name name of the parameter
 245  * @cfg {String} desc  short description
 246  * @cfg {String} defaultvalue default value
 247  *
 248  * @constructor
 249  * Create a new Param
 250  * @param {Object} config The config object
 251  */
 252
 253 </span><span class="jsdoc-var">Roo.doc.Param </span><span class="jsdoc-syntax">= </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">config</span><span class="jsdoc-syntax">){
 254     </span><span class="jsdoc-var">Roo.doc.Param.superclass.constructor.call</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">this</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">config</span><span class="jsdoc-syntax">);
 255 };
 256
 257 </span><span class="jsdoc-var">Roo.extend</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">Roo.doc.Param</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">Roo.bootstrap.Component</span><span class="jsdoc-syntax">,  {
 258
 259     </span><span class="jsdoc-var">is_optional </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">false</span><span class="jsdoc-syntax">,
 260     </span><span class="jsdoc-var">type </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">''</span><span class="jsdoc-syntax">,
 261     </span><span class="jsdoc-var">name</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">''</span><span class="jsdoc-syntax">,
 262     </span><span class="jsdoc-var">defaultvalue</span><span class="jsdoc-syntax">:   </span><span class="jsdoc-string">''</span><span class="jsdoc-syntax">,
 263     </span><span class="jsdoc-var">desc</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">''</span><span class="jsdoc-syntax">,
 264
 265     </span><span class="jsdoc-var">getAutoCreate </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(){
 266
 267         </span><span class="jsdoc-comment">//?? this is the synopsis type....
 268
 269
 270         </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">) {
 271
 272             </span><span class="jsdoc-keyword">return </span><span class="jsdoc-syntax">{
 273                 </span><span class="jsdoc-var">tag </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'li'</span><span class="jsdoc-syntax">,
 274                 </span><span class="jsdoc-var">cn </span><span class="jsdoc-syntax">: [
 275                     {
 276                         </span><span class="jsdoc-var">tag </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'p'</span><span class="jsdoc-syntax">,
 277                         </span><span class="jsdoc-var">cls</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'para'</span><span class="jsdoc-syntax">,
 278                         </span><span class="jsdoc-var">cn </span><span class="jsdoc-syntax">: [
 279                             {
 280                                 </span><span class="jsdoc-var">tag</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'code'</span><span class="jsdoc-syntax">,
 281                                 </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
 282                             </span><span class="jsdoc-syntax">},
 283                             </span><span class="jsdoc-var">this.desc
 284                         </span><span class="jsdoc-syntax">]
 285                     }
 286                 ]
 287             };
 288
 289         }
 290          </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">'return'</span><span class="jsdoc-syntax">) {
 291             </span><span class="jsdoc-keyword">return </span><span class="jsdoc-syntax">{
 292                     </span><span class="jsdoc-var">tag </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'p'</span><span class="jsdoc-syntax">,
 293                     </span><span class="jsdoc-var">cls</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'para'</span><span class="jsdoc-syntax">,
 294                     </span><span class="jsdoc-var">cn </span><span class="jsdoc-syntax">: [
 295                         {
 296                             </span><span class="jsdoc-var">tag</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'code'</span><span class="jsdoc-syntax">,
 297                             </span><span class="jsdoc-var">html </span><span class="jsdoc-syntax">: </span><span class="jsdoc-var">this.type
 298                         </span><span class="jsdoc-syntax">},
 299                         </span><span class="jsdoc-var">this.desc
 300                     </span><span class="jsdoc-syntax">]
 301                 };
 302
 303          }
 304
 305
 306
 307         </span><span class="jsdoc-comment">// this is not very fancy...
 308
 309         </span><span class="jsdoc-keyword">var </span><span class="jsdoc-var">cfg </span><span class="jsdoc-syntax">={
 310             </span><span class="jsdoc-var">tag</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'span'</span><span class="jsdoc-syntax">,
 311             </span><span class="jsdoc-var">cn </span><span class="jsdoc-syntax">: [
 312                 </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">,
 313                 </span><span class="jsdoc-var">this.type</span><span class="jsdoc-syntax">,
 314                 </span><span class="jsdoc-string">' '</span><span class="jsdoc-syntax">,
 315                 {
 316                     </span><span class="jsdoc-var">tag </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'b'</span><span class="jsdoc-syntax">,
 317                     </span><span class="jsdoc-var">html </span><span class="jsdoc-syntax">: </span><span class="jsdoc-var">this.name
 318                 </span><span class="jsdoc-syntax">},
 319                 </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">,
 320                 </span><span class="jsdoc-var">this.defaultvalue</span><span class="jsdoc-syntax">,
 321                 </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">,
 322                 </span><span class="jsdoc-string">',' </span><span class="jsdoc-comment">// not really.. but let's do it anyway...
 323             </span><span class="jsdoc-syntax">]
 324         };
 325
 326
 327
 328
 329         </span><span class="jsdoc-keyword">return </span><span class="jsdoc-var">cfg</span><span class="jsdoc-syntax">;
 330     },
 331     </span><span class="jsdoc-var">getAutoCreateParamSection </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">()
 332     {
 333         </span><span class="jsdoc-keyword">return </span><span class="jsdoc-syntax">{
 334                </span><span class="jsdoc-var">tag </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'li'</span><span class="jsdoc-syntax">,
 335                </span><span class="jsdoc-var">cn </span><span class="jsdoc-syntax">: [
 336                    {
 337                        </span><span class="jsdoc-var">tag </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'p'</span><span class="jsdoc-syntax">,
 338                        </span><span class="jsdoc-var">cls</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'para'</span><span class="jsdoc-syntax">,
 339                        </span><span class="jsdoc-var">cn </span><span class="jsdoc-syntax">: [
 340                            {
 341                                </span><span class="jsdoc-var">tag</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'code'</span><span class="jsdoc-syntax">,
 342                                </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
 343                            </span><span class="jsdoc-syntax">},
 344                            </span><span class="jsdoc-var">this.desc
 345                        </span><span class="jsdoc-syntax">]
 346                    }
 347                ]
 348            };
 349
 350
 351     }
 352
 353
 354
 355
 356
 357
 358
 359 });
 360
 361
 362
 363  </span><span class="jsdoc-comment">/*
 364  * - LGPL
 365  *
 366  */
 367
 368 /**
 369  * @class Roo.doc.Section
 370  * @extends Roo.bootstrap.Component
 371  * SectionElement class
 372  * @cfg {String} stype (desc|parameter|return|note|example) section type.
 373  *
 374  * @constructor
 375  * Create a new Synopsis
 376  * @param {Object} config The config object
 377  */
 378
 379 </span><span class="jsdoc-var">Roo.doc.Section </span><span class="jsdoc-syntax">= </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">config</span><span class="jsdoc-syntax">){
 380     </span><span class="jsdoc-var">Roo.doc.Section.superclass.constructor.call</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">this</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">config</span><span class="jsdoc-syntax">);
 381 };
 382
 383 </span><span class="jsdoc-var">Roo.extend</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">Roo.doc.Section</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">Roo.bootstrap.Component</span><span class="jsdoc-syntax">,  {
 384
 385
 386     </span><span class="jsdoc-var">stype</span><span class="jsdoc-syntax">:   </span><span class="jsdoc-string">''</span><span class="jsdoc-syntax">,
 387
 388     </span><span class="jsdoc-var">getAutoCreate </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(){
 389
 390
 391
 392
 393         </span><span class="jsdoc-keyword">var </span><span class="jsdoc-var">cfg </span><span class="jsdoc-syntax">={
 394
 395             </span><span class="jsdoc-var">cls </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'refsection'</span><span class="jsdoc-syntax">,
 396             </span><span class="jsdoc-comment">// id... ?
 397             </span><span class="jsdoc-var">cn </span><span class="jsdoc-syntax">: [
 398                 {
 399                     </span><span class="jsdoc-var">tag</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'h3'</span><span class="jsdoc-syntax">,
 400                     </span><span class="jsdoc-var">cls </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'title'</span><span class="jsdoc-syntax">,
 401                     </span><span class="jsdoc-var">html </span><span class="jsdoc-syntax">: </span><span class="jsdoc-var">Roo.doc.Section.map</span><span class="jsdoc-syntax">[</span><span class="jsdoc-var">this.stype</span><span class="jsdoc-syntax">]
 402                 }
 403             ]
 404         };
 405         </span><span class="jsdoc-keyword">if </span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">this.stype </span><span class="jsdoc-syntax">== </span><span class="jsdoc-string">'parameter'</span><span class="jsdoc-syntax">) {
 406
 407             </span><span class="jsdoc-comment">// db package uses variable list here... - it results in dd/dl but the layout is messed up..
 408
 409             </span><span class="jsdoc-keyword">var </span><span class="jsdoc-var">ul </span><span class="jsdoc-syntax">= {
 410                 </span><span class="jsdoc-var">tag</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'ul'</span><span class="jsdoc-syntax">,
 411                 </span><span class="jsdoc-var">cls</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'itemizedlist roo-params'</span><span class="jsdoc-syntax">,
 412                 </span><span class="jsdoc-var">cn </span><span class="jsdoc-syntax">: []
 413             };
 414             </span><span class="jsdoc-comment">// might not have any..
 415             </span><span class="jsdoc-keyword">var </span><span class="jsdoc-var">params </span><span class="jsdoc-syntax">= </span><span class="jsdoc-var">this.parent</span><span class="jsdoc-syntax">()</span><span class="jsdoc-var">.items</span><span class="jsdoc-syntax">[0]</span><span class="jsdoc-var">.items</span><span class="jsdoc-syntax">;
 416             </span><span class="jsdoc-keyword">for </span><span class="jsdoc-syntax">(</span><span class="jsdoc-keyword">var </span><span class="jsdoc-var">i </span><span class="jsdoc-syntax">=0; </span><span class="jsdoc-var">i </span><span class="jsdoc-syntax">&lt; </span><span class="jsdoc-var">params.length</span><span class="jsdoc-syntax">;</span><span class="jsdoc-var">i</span><span class="jsdoc-syntax">++) {
 417                 </span><span class="jsdoc-var">ul.cn.push</span><span class="jsdoc-syntax">( </span><span class="jsdoc-var">Roo.factory</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">params</span><span class="jsdoc-syntax">[</span><span class="jsdoc-var">i</span><span class="jsdoc-syntax">])</span><span class="jsdoc-var">.getAutoCreateParamSection</span><span class="jsdoc-syntax">() )
 418             }
 419
 420
 421             </span><span class="jsdoc-var">cfg.cn.push</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">ul</span><span class="jsdoc-syntax">);
 422         }
 423
 424
 425         </span><span class="jsdoc-keyword">return </span><span class="jsdoc-var">cfg</span><span class="jsdoc-syntax">;
 426     },
 427     </span><span class="jsdoc-var">getChildContainer </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">build_call</span><span class="jsdoc-syntax">)
 428     {
 429
 430         </span><span class="jsdoc-keyword">if </span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">this.stype </span><span class="jsdoc-syntax">== </span><span class="jsdoc-string">'parameter'</span><span class="jsdoc-syntax">) {
 431             </span><span class="jsdoc-keyword">return </span><span class="jsdoc-var">this.el.select</span><span class="jsdoc-syntax">(</span><span class="jsdoc-string">'.roo-params'</span><span class="jsdoc-syntax">,</span><span class="jsdoc-keyword">true</span><span class="jsdoc-syntax">)</span><span class="jsdoc-var">.first</span><span class="jsdoc-syntax">();
 432         }
 433         </span><span class="jsdoc-keyword">return </span><span class="jsdoc-var">this.el</span><span class="jsdoc-syntax">;
 434     }
 435
 436
 437
 438 });
 439
 440
 441 </span><span class="jsdoc-var">Roo.doc.Section.map </span><span class="jsdoc-syntax">= {
 442     </span><span class="jsdoc-string">'desc' </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'Description'</span><span class="jsdoc-syntax">,
 443     </span><span class="jsdoc-string">'parameter' </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'Parameters'</span><span class="jsdoc-syntax">,
 444     </span><span class="jsdoc-string">'return' </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'Return Value'</span><span class="jsdoc-syntax">,
 445     </span><span class="jsdoc-string">'note' </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'Notes'</span><span class="jsdoc-syntax">,
 446     </span><span class="jsdoc-string">'example' </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'Examples'
 447 </span><span class="jsdoc-syntax">}
 448 </span><span class="jsdoc-comment">/*
 449  * - LGPL
 450  *
 451  */
 452
 453 /**
 454  * @class Roo.doc.Synopsis
 455  * @extends Roo.bootstrap.Component
 456  * Synopsis Element class
 457  * @cfg {String} returntype return value
 458  * @cfg {String} name title really..
 459  * @cfg {String} stype (function|constant)
 460  * @cfg {String} memberof class name
 461  * @cfg {bool} is_static is a static member
 462  *
 463  * @constructor
 464  * Create a new Synopsis
 465  * @param {Object} config The config object
 466  */
 467
 468 </span><span class="jsdoc-var">Roo.doc.Synopsis </span><span class="jsdoc-syntax">= </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">config</span><span class="jsdoc-syntax">){
 469     </span><span class="jsdoc-var">Roo.doc.Synopsis.superclass.constructor.call</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">this</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">config</span><span class="jsdoc-syntax">);
 470 };
 471
 472 </span><span class="jsdoc-var">Roo.extend</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">Roo.doc.Synopsis</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">Roo.bootstrap.Component</span><span class="jsdoc-syntax">,  {
 473
 474     </span><span class="jsdoc-var">memberof </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">''</span><span class="jsdoc-syntax">,
 475     </span><span class="jsdoc-var">is_static </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">false</span><span class="jsdoc-syntax">,
 476     </span><span class="jsdoc-var">returntype </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">''</span><span class="jsdoc-syntax">,
 477     </span><span class="jsdoc-var">name</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">''</span><span class="jsdoc-syntax">,
 478     </span><span class="jsdoc-var">stype</span><span class="jsdoc-syntax">:   </span><span class="jsdoc-string">'function'</span><span class="jsdoc-syntax">,
 479
 480     </span><span class="jsdoc-var">getAutoCreate </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(){
 481
 482         </span><span class="jsdoc-keyword">var </span><span class="jsdoc-var">syn </span><span class="jsdoc-syntax">= </span><span class="jsdoc-var">this.items</span><span class="jsdoc-syntax">[0]; </span><span class="jsdoc-comment">// hopefully...
 483         </span><span class="jsdoc-var">Roo.log</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">this.items</span><span class="jsdoc-syntax">);
 484
 485
 486         </span><span class="jsdoc-keyword">var </span><span class="jsdoc-var">cfg </span><span class="jsdoc-syntax">={
 487             </span><span class="jsdoc-var">tag</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'h5'</span><span class="jsdoc-syntax">,
 488             </span><span class="jsdoc-var">cls </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'refsynopsisdiv'</span><span class="jsdoc-syntax">,
 489             </span><span class="jsdoc-var">cn </span><span class="jsdoc-syntax">: [
 490                 {
 491                     </span><span class="jsdoc-var">cls</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'funcsynopsis'</span><span class="jsdoc-syntax">,
 492                     </span><span class="jsdoc-var">cn</span><span class="jsdoc-syntax">: [
 493                         {
 494                             </span><span class="jsdoc-var">tag</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'p'</span><span class="jsdoc-syntax">,
 495                             </span><span class="jsdoc-var">cn</span><span class="jsdoc-syntax">: {
 496                                 </span><span class="jsdoc-var">tag</span><span class="jsdoc-syntax">:</span><span class="jsdoc-string">'code'</span><span class="jsdoc-syntax">,
 497                                 </span><span class="jsdoc-var">cls </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'funcprototype'</span><span class="jsdoc-syntax">,
 498                                 </span><span class="jsdoc-var">cn</span><span class="jsdoc-syntax">: [
 499                                     </span><span class="jsdoc-var">this.returntype </span><span class="jsdoc-syntax">+ </span><span class="jsdoc-string">' '</span><span class="jsdoc-syntax">,
 500                                     {
 501                                         </span><span class="jsdoc-var">tag</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'strong'</span><span class="jsdoc-syntax">,
 502                                         </span><span class="jsdoc-var">cls </span><span class="jsdoc-syntax">: </span><span class="jsdoc-var">this.stype</span><span class="jsdoc-syntax">,
 503                                         </span><span class="jsdoc-var">html </span><span class="jsdoc-syntax">: </span><span class="jsdoc-var">this.name
 504                                     </span><span class="jsdoc-syntax">},
 505                                     </span><span class="jsdoc-string">'('</span><span class="jsdoc-syntax">,
 506                                     {
 507                                         </span><span class="jsdoc-var">tag</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'span'</span><span class="jsdoc-syntax">,
 508                                         </span><span class="jsdoc-var">cls </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'roo-params'
 509                                     </span><span class="jsdoc-syntax">},
 510                                     </span><span class="jsdoc-string">')'
 511                                 </span><span class="jsdoc-syntax">]
 512
 513                             }
 514                         }
 515                     ]
 516                 }
 517
 518             ]
 519         };
 520
 521
 522
 523         </span><span class="jsdoc-keyword">return </span><span class="jsdoc-var">cfg</span><span class="jsdoc-syntax">;
 524     },
 525     </span><span class="jsdoc-var">getChildContainer </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">build_call</span><span class="jsdoc-syntax">)
 526     {
 527
 528
 529         </span><span class="jsdoc-keyword">return </span><span class="jsdoc-var">this.el.select</span><span class="jsdoc-syntax">(</span><span class="jsdoc-string">'.roo-params'</span><span class="jsdoc-syntax">,</span><span class="jsdoc-keyword">true</span><span class="jsdoc-syntax">)</span><span class="jsdoc-var">.first</span><span class="jsdoc-syntax">();
 530     }
 531
 532
 533
 534
 535
 536 });
 537
 538
 539
 540  </span></code></body></html>