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     /*
  26     var body = Roo.get(document.body);
  27     body.attr({
  28         leftmargin : 0,
  29         marginwidth : 0,
  30         topmargin : 0,
  31         marginheight : 0,
  32         offset : 0
  33     });
  34
  35
  36     // call onRender once... and block next call...?
  37     this.onRender(body);
  38     this.el = body;
  39     //this.onRender = function() { };
  40     */
  41
  42 </span><span class="jsdoc-syntax">};
  43
  44 </span><span class="jsdoc-comment">//Roo.doc.Entry._calls = 0;
  45
  46 </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">,  {
  47
  48
  49     </span><span class="jsdoc-var">name </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">''</span><span class="jsdoc-syntax">,
  50     </span><span class="jsdoc-var">purpose </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">''</span><span class="jsdoc-syntax">,
  51
  52     </span><span class="jsdoc-var">getAutoCreate </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(){
  53
  54         </span><span class="jsdoc-keyword">var </span><span class="jsdoc-var">cfg </span><span class="jsdoc-syntax">={
  55             </span><span class="jsdoc-var">cls </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'refentry'</span><span class="jsdoc-syntax">,
  56             </span><span class="jsdoc-var">cn </span><span class="jsdoc-syntax">: [
  57                 {
  58                     </span><span class="jsdoc-var">tag</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'h1'</span><span class="jsdoc-syntax">,
  59                     </span><span class="jsdoc-var">cls</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'refname'</span><span class="jsdoc-syntax">,
  60                     </span><span class="jsdoc-var">html </span><span class="jsdoc-syntax">: </span><span class="jsdoc-var">this.name
  61                 </span><span class="jsdoc-syntax">},
  62                 {
  63                     </span><span class="jsdoc-var">cls</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'refnamediv'</span><span class="jsdoc-syntax">,
  64                     </span><span class="jsdoc-var">html </span><span class="jsdoc-syntax">: </span><span class="jsdoc-var">this.purpose
  65                 </span><span class="jsdoc-syntax">}
  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     </span><span class="jsdoc-comment">/*
  78     onRender : function(ct, position)
  79     {
  80
  81         Roo.doc.Entry._calls++;
  82         if (Roo.doc.Entry._calls &gt; 1 || !ct) {
  83             return;
  84         }
  85
  86     // call onRender once... and block next call...?
  87
  88         Roo.bootstrap.Component.prototype.onRender.call(this, ct, position);
  89     }
  90     */
  91
  92 </span><span class="jsdoc-syntax">});
  93
  94
  95
  96  </span><span class="jsdoc-comment">/*
  97  * - LGPL
  98  *
  99  */
 100
 101 /**
 102  * @class Roo.doc.Example
 103  * @extends Roo.bootstrap.Component
 104  * Example Element class
 105  * @cfg {String} title short title describing example
 106  * @cfg {String} lang (php|txt|sql) section type.
 107  * @cfg {String} code  example code
 108  * @cfg {String} output The expected output from the code
 109  *
 110  *
 111  * @constructor
 112  * Create a new Synopsis
 113  * @param {Object} config The config object
 114  */
 115
 116 </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">){
 117     </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">);
 118 };
 119
 120 </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">,  {
 121
 122     </span><span class="jsdoc-var">title </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">''</span><span class="jsdoc-syntax">,
 123     </span><span class="jsdoc-var">lang</span><span class="jsdoc-syntax">:   </span><span class="jsdoc-string">'php'</span><span class="jsdoc-syntax">,
 124     </span><span class="jsdoc-var">code </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">''</span><span class="jsdoc-syntax">,
 125     </span><span class="jsdoc-var">output </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">''</span><span class="jsdoc-syntax">,
 126     </span><span class="jsdoc-var">outputlang </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'txt'</span><span class="jsdoc-syntax">,
 127
 128     </span><span class="jsdoc-var">getAutoCreate </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(){
 129
 130         </span><span class="jsdoc-comment">// no colour highlighting in here....
 131
 132         </span><span class="jsdoc-keyword">var </span><span class="jsdoc-var">code </span><span class="jsdoc-syntax">= </span><span class="jsdoc-var">hljs </span><span class="jsdoc-syntax">? </span><span class="jsdoc-var">hljs.highlight</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">this.lang</span><span class="jsdoc-syntax">,</span><span class="jsdoc-var">this.code</span><span class="jsdoc-syntax">)</span><span class="jsdoc-var">.value </span><span class="jsdoc-syntax">:
 133                 </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">);
 134
 135
 136         </span><span class="jsdoc-keyword">var </span><span class="jsdoc-var">cfg </span><span class="jsdoc-syntax">={
 137             </span><span class="jsdoc-var">cls </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'panel panel-info'</span><span class="jsdoc-syntax">,
 138             </span><span class="jsdoc-var">cn </span><span class="jsdoc-syntax">: [
 139                 {
 140                     </span><span class="jsdoc-var">cls </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'panel-heading'</span><span class="jsdoc-syntax">,
 141                     </span><span class="jsdoc-var">html </span><span class="jsdoc-syntax">: </span><span class="jsdoc-var">this.title
 142                 </span><span class="jsdoc-syntax">},
 143                 {
 144                     </span><span class="jsdoc-var">cls </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'panel-body'</span><span class="jsdoc-syntax">,
 145                     </span><span class="jsdoc-var">cn </span><span class="jsdoc-syntax">: [
 146                         {
 147                             </span><span class="jsdoc-var">tag</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'pre'</span><span class="jsdoc-syntax">,
 148                             </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">,
 149                             </span><span class="jsdoc-var">html </span><span class="jsdoc-syntax">:  </span><span class="jsdoc-var">code
 150                         </span><span class="jsdoc-syntax">}
 151                     ]
 152                 }
 153             ]
 154         };
 155
 156         </span><span class="jsdoc-keyword">if </span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">this.output</span><span class="jsdoc-syntax">) {
 157
 158             </span><span class="jsdoc-keyword">var </span><span class="jsdoc-var">out </span><span class="jsdoc-syntax">= </span><span class="jsdoc-var">hljs </span><span class="jsdoc-syntax">? </span><span class="jsdoc-var">hljs.highlight</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">this.outputlang</span><span class="jsdoc-syntax">,</span><span class="jsdoc-var">this.output</span><span class="jsdoc-syntax">)</span><span class="jsdoc-var">.value </span><span class="jsdoc-syntax">:
 159                     </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">);
 160             </span><span class="jsdoc-var">cfg.cn.push</span><span class="jsdoc-syntax">(
 161
 162                 {
 163                     </span><span class="jsdoc-var">cls </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'panel-footer'</span><span class="jsdoc-syntax">,
 164                     </span><span class="jsdoc-var">cn </span><span class="jsdoc-syntax">: {
 165                         </span><span class="jsdoc-var">tag</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'pre'</span><span class="jsdoc-syntax">,
 166                         </span><span class="jsdoc-var">html </span><span class="jsdoc-syntax">: </span><span class="jsdoc-var">out
 167                     </span><span class="jsdoc-syntax">}
 168                 }
 169
 170
 171             );
 172         }
 173
 174
 175
 176         </span><span class="jsdoc-keyword">return </span><span class="jsdoc-var">cfg</span><span class="jsdoc-syntax">;
 177     }
 178
 179
 180
 181
 182 });
 183
 184
 185
 186  </span><span class="jsdoc-comment">/*
 187  * - LGPL
 188  *
 189  */
 190
 191 /**
 192  * @class Roo.doc.Para
 193  * @extends Roo.bootstrap.Component
 194  * Param Element class
 195  * @cfg {String} html
 196  *
 197  * @constructor
 198  * Create a new Paragraph
 199  * @param {Object} config The config object
 200  */
 201
 202 </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">){
 203     </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">);
 204 };
 205
 206 </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">,  {
 207
 208     </span><span class="jsdoc-var">html </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">''</span><span class="jsdoc-syntax">,
 209     </span><span class="jsdoc-var">getAutoCreate </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(){
 210
 211         </span><span class="jsdoc-comment">//?? this is the synopsis type....
 212
 213         // this is not very fancy...
 214
 215         </span><span class="jsdoc-keyword">var </span><span class="jsdoc-var">cfg </span><span class="jsdoc-syntax">={
 216             </span><span class="jsdoc-var">tag</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'p'</span><span class="jsdoc-syntax">,
 217             </span><span class="jsdoc-var">cls</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'para'</span><span class="jsdoc-syntax">,
 218             </span><span class="jsdoc-var">html </span><span class="jsdoc-syntax">: </span><span class="jsdoc-var">this.html
 219         </span><span class="jsdoc-syntax">};
 220
 221         </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">) {
 222             </span><span class="jsdoc-keyword">return </span><span class="jsdoc-syntax">{
 223                 </span><span class="jsdoc-var">tag</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'li'</span><span class="jsdoc-syntax">,
 224                 </span><span class="jsdoc-var">cls </span><span class="jsdoc-syntax">: </span><span class="jsdoc-var">listitme</span><span class="jsdoc-syntax">,
 225                 </span><span class="jsdoc-var">cn </span><span class="jsdoc-syntax">: [ </span><span class="jsdoc-var">cfg </span><span class="jsdoc-syntax">]
 226             };
 227
 228         }
 229
 230         </span><span class="jsdoc-keyword">return </span><span class="jsdoc-var">cfg</span><span class="jsdoc-syntax">;
 231     }
 232
 233
 234
 235
 236
 237
 238 });
 239
 240
 241
 242  </span><span class="jsdoc-comment">/*
 243  * - LGPL
 244  *
 245  */
 246
 247 /**
 248  * @class Roo.doc.Param
 249  * @extends Roo.bootstrap.Component
 250  * Param Element class
 251  * @cfg {bool} is_optional is the argument optional
 252  * @cfg {String} type  argument type
 253  * @cfg {String} name name of the parameter
 254  * @cfg {String} desc  short description
 255  * @cfg {String} defaultvalue default value
 256  *
 257  * @constructor
 258  * Create a new Param
 259  * @param {Object} config The config object
 260  */
 261
 262 </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">){
 263     </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">);
 264 };
 265
 266 </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">,  {
 267
 268     </span><span class="jsdoc-var">is_optional </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">false</span><span class="jsdoc-syntax">,
 269     </span><span class="jsdoc-var">type </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">''</span><span class="jsdoc-syntax">,
 270     </span><span class="jsdoc-var">name</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">''</span><span class="jsdoc-syntax">,
 271     </span><span class="jsdoc-var">defaultvalue</span><span class="jsdoc-syntax">:   </span><span class="jsdoc-string">''</span><span class="jsdoc-syntax">,
 272     </span><span class="jsdoc-var">desc</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">''</span><span class="jsdoc-syntax">,
 273
 274     </span><span class="jsdoc-var">getAutoCreate </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(){
 275
 276         </span><span class="jsdoc-comment">//?? this is the synopsis type....
 277
 278
 279         </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">) {
 280
 281             </span><span class="jsdoc-keyword">return </span><span class="jsdoc-syntax">{
 282                 </span><span class="jsdoc-var">tag </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'li'</span><span class="jsdoc-syntax">,
 283                 </span><span class="jsdoc-var">cn </span><span class="jsdoc-syntax">: [
 284                     {
 285                         </span><span class="jsdoc-var">tag </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'p'</span><span class="jsdoc-syntax">,
 286                         </span><span class="jsdoc-var">cls</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'para'</span><span class="jsdoc-syntax">,
 287                         </span><span class="jsdoc-var">cn </span><span class="jsdoc-syntax">: [
 288                             {
 289                                 </span><span class="jsdoc-var">tag</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'code'</span><span class="jsdoc-syntax">,
 290                                 </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
 291                             </span><span class="jsdoc-syntax">},
 292                             </span><span class="jsdoc-var">this.desc
 293                         </span><span class="jsdoc-syntax">]
 294                     }
 295                 ]
 296             };
 297
 298         }
 299          </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">) {
 300             </span><span class="jsdoc-keyword">return </span><span class="jsdoc-syntax">{
 301                     </span><span class="jsdoc-var">tag </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'p'</span><span class="jsdoc-syntax">,
 302                     </span><span class="jsdoc-var">cls</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'para'</span><span class="jsdoc-syntax">,
 303                     </span><span class="jsdoc-var">cn </span><span class="jsdoc-syntax">: [
 304                         {
 305                             </span><span class="jsdoc-var">tag</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'code'</span><span class="jsdoc-syntax">,
 306                             </span><span class="jsdoc-var">html </span><span class="jsdoc-syntax">: </span><span class="jsdoc-var">this.type
 307                         </span><span class="jsdoc-syntax">},
 308                         </span><span class="jsdoc-var">this.desc
 309                     </span><span class="jsdoc-syntax">]
 310                 };
 311
 312          }
 313
 314
 315
 316         </span><span class="jsdoc-comment">// this is not very fancy...
 317
 318         </span><span class="jsdoc-keyword">var </span><span class="jsdoc-var">cfg </span><span class="jsdoc-syntax">={
 319             </span><span class="jsdoc-var">tag</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'span'</span><span class="jsdoc-syntax">,
 320             </span><span class="jsdoc-var">cn </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-var">this.type</span><span class="jsdoc-syntax">,
 323                 </span><span class="jsdoc-string">' '</span><span class="jsdoc-syntax">,
 324                 {
 325                     </span><span class="jsdoc-var">tag </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'b'</span><span class="jsdoc-syntax">,
 326                     </span><span class="jsdoc-var">html </span><span class="jsdoc-syntax">: </span><span class="jsdoc-var">this.name
 327                 </span><span class="jsdoc-syntax">},
 328                 </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">,
 329                 </span><span class="jsdoc-var">this.defaultvalue</span><span class="jsdoc-syntax">,
 330                 </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">,
 331                 </span><span class="jsdoc-string">',' </span><span class="jsdoc-comment">// not really.. but let's do it anyway...
 332             </span><span class="jsdoc-syntax">]
 333         };
 334
 335
 336
 337
 338         </span><span class="jsdoc-keyword">return </span><span class="jsdoc-var">cfg</span><span class="jsdoc-syntax">;
 339     },
 340     </span><span class="jsdoc-var">getAutoCreateParamSection </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">()
 341     {
 342         </span><span class="jsdoc-keyword">return </span><span class="jsdoc-syntax">{
 343                </span><span class="jsdoc-var">tag </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'li'</span><span class="jsdoc-syntax">,
 344                </span><span class="jsdoc-var">cn </span><span class="jsdoc-syntax">: [
 345                    {
 346                        </span><span class="jsdoc-var">tag </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'p'</span><span class="jsdoc-syntax">,
 347                        </span><span class="jsdoc-var">cls</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'para'</span><span class="jsdoc-syntax">,
 348                        </span><span class="jsdoc-var">cn </span><span class="jsdoc-syntax">: [
 349                            {
 350                                </span><span class="jsdoc-var">tag</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'code'</span><span class="jsdoc-syntax">,
 351                                </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
 352                            </span><span class="jsdoc-syntax">},
 353                            </span><span class="jsdoc-var">this.desc
 354                        </span><span class="jsdoc-syntax">]
 355                    }
 356                ]
 357            };
 358
 359
 360     }
 361
 362
 363
 364
 365
 366
 367
 368 });
 369
 370
 371
 372  </span><span class="jsdoc-comment">/*
 373  * - LGPL
 374  *
 375  */
 376
 377 /**
 378  * @class Roo.doc.Section
 379  * @extends Roo.bootstrap.Component
 380  * SectionElement class
 381  * @cfg {String} stype (desc|parameter|return|note|example) section type.
 382  *
 383  * @constructor
 384  * Create a new Synopsis
 385  * @param {Object} config The config object
 386  */
 387
 388 </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">){
 389     </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">);
 390 };
 391
 392 </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">,  {
 393
 394
 395     </span><span class="jsdoc-var">stype</span><span class="jsdoc-syntax">:   </span><span class="jsdoc-string">''</span><span class="jsdoc-syntax">,
 396
 397     </span><span class="jsdoc-var">getAutoCreate </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(){
 398
 399
 400         </span><span class="jsdoc-keyword">var </span><span class="jsdoc-var">syn </span><span class="jsdoc-syntax">= </span><span class="jsdoc-var">Roo.factory</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]);
 401
 402         </span><span class="jsdoc-keyword">var </span><span class="jsdoc-var">cfg </span><span class="jsdoc-syntax">={
 403
 404             </span><span class="jsdoc-var">cls </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'refsection'</span><span class="jsdoc-syntax">,
 405             </span><span class="jsdoc-comment">// id... ?
 406             </span><span class="jsdoc-var">cn </span><span class="jsdoc-syntax">: [
 407                 {
 408                     </span><span class="jsdoc-var">tag</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'h3'</span><span class="jsdoc-syntax">,
 409                     </span><span class="jsdoc-var">cls </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'title'</span><span class="jsdoc-syntax">,
 410                     </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">]
 411                 }
 412             ]
 413         };
 414         </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">) {
 415
 416             </span><span class="jsdoc-comment">// db package uses variable list here... - it results in dd/dl but the layout is messed up..
 417
 418             </span><span class="jsdoc-keyword">var </span><span class="jsdoc-var">ul </span><span class="jsdoc-syntax">= {
 419                 </span><span class="jsdoc-var">tag</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'ul'</span><span class="jsdoc-syntax">,
 420                 </span><span class="jsdoc-var">cls</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'itemizedlist roo-params'</span><span class="jsdoc-syntax">,
 421                 </span><span class="jsdoc-var">cn </span><span class="jsdoc-syntax">: []
 422             };
 423             </span><span class="jsdoc-comment">// might not have any..
 424             </span><span class="jsdoc-keyword">var </span><span class="jsdoc-var">params </span><span class="jsdoc-syntax">= </span><span class="jsdoc-var">syn.items</span><span class="jsdoc-syntax">;
 425             </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">++) {
 426                 </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">() )
 427             }
 428
 429
 430             </span><span class="jsdoc-var">cfg.cn.push</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">ul</span><span class="jsdoc-syntax">);
 431         }
 432         </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">'return' </span><span class="jsdoc-syntax">&amp;&amp; </span><span class="jsdoc-var">syn.returndesc.length</span><span class="jsdoc-syntax">) {
 433
 434             </span><span class="jsdoc-var">cfg.cn.push</span><span class="jsdoc-syntax">({
 435                 </span><span class="jsdoc-var">tag</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'p'</span><span class="jsdoc-syntax">,
 436                 </span><span class="jsdoc-var">cls </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'para'</span><span class="jsdoc-syntax">,
 437                 </span><span class="jsdoc-var">cn </span><span class="jsdoc-syntax">: [
 438
 439                     {
 440                         </span><span class="jsdoc-var">tag</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'code'</span><span class="jsdoc-syntax">,
 441                         </span><span class="jsdoc-var">cls</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'parameter'</span><span class="jsdoc-syntax">,
 442                         </span><span class="jsdoc-var">html </span><span class="jsdoc-syntax">: </span><span class="jsdoc-var">syn.returntype
 443                     </span><span class="jsdoc-syntax">},
 444                     </span><span class="jsdoc-var">syn.returndesc
 445                 </span><span class="jsdoc-syntax">]
 446
 447             });
 448         }
 449
 450         </span><span class="jsdoc-keyword">return </span><span class="jsdoc-var">cfg</span><span class="jsdoc-syntax">;
 451     },
 452     </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">)
 453     {
 454
 455         </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">) {
 456             </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">();
 457         }
 458
 459         </span><span class="jsdoc-keyword">return </span><span class="jsdoc-var">this.el</span><span class="jsdoc-syntax">;
 460     }
 461
 462
 463
 464 });
 465
 466
 467 </span><span class="jsdoc-var">Roo.doc.Section.map </span><span class="jsdoc-syntax">= {
 468     </span><span class="jsdoc-string">'desc' </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'Description'</span><span class="jsdoc-syntax">,
 469     </span><span class="jsdoc-string">'parameter' </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'Parameters'</span><span class="jsdoc-syntax">,
 470     </span><span class="jsdoc-string">'return' </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'Return Value'</span><span class="jsdoc-syntax">,
 471     </span><span class="jsdoc-string">'note' </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'Notes'</span><span class="jsdoc-syntax">,
 472     </span><span class="jsdoc-string">'example' </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'Examples'
 473 </span><span class="jsdoc-syntax">}
 474 </span><span class="jsdoc-comment">/*
 475  * - LGPL
 476  *
 477  */
 478
 479 /**
 480  * @class Roo.doc.Synopsis
 481  * @extends Roo.bootstrap.Component
 482  * Synopsis Element class
 483  * @cfg {String} returntype return value
 484  * @cfg {String} returndesc description of return value. (used in the return section if set..)
 485  * @cfg {String} name title really..
 486  * @cfg {String} stype (function|constant)
 487  * @cfg {String} memberof class name
 488  * @cfg {bool} is_static is a static member
 489  *
 490  * @constructor
 491  * Create a new Synopsis
 492  * @param {Object} config The config object
 493  */
 494
 495 </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">){
 496     </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">);
 497 };
 498
 499 </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">,  {
 500
 501     </span><span class="jsdoc-var">memberof </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">''</span><span class="jsdoc-syntax">,
 502     </span><span class="jsdoc-var">is_static </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">false</span><span class="jsdoc-syntax">,
 503     </span><span class="jsdoc-var">returntype </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">''</span><span class="jsdoc-syntax">,
 504     </span><span class="jsdoc-var">returndesc </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">''</span><span class="jsdoc-syntax">,
 505     </span><span class="jsdoc-var">name</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">''</span><span class="jsdoc-syntax">,
 506     </span><span class="jsdoc-var">stype</span><span class="jsdoc-syntax">:   </span><span class="jsdoc-string">'function'</span><span class="jsdoc-syntax">,
 507
 508     </span><span class="jsdoc-var">getAutoCreate </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(){
 509
 510         </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...
 511
 512
 513
 514         </span><span class="jsdoc-keyword">var </span><span class="jsdoc-var">nmp </span><span class="jsdoc-syntax">= (</span><span class="jsdoc-var">this.is_static </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">) +
 515             </span><span class="jsdoc-var">this.memberof </span><span class="jsdoc-syntax">+
 516             (</span><span class="jsdoc-var">this.is_static </span><span class="jsdoc-syntax">? </span><span class="jsdoc-string">'::' </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'-&gt;'</span><span class="jsdoc-syntax">);
 517
 518
 519         </span><span class="jsdoc-comment">// this should probably do the params....?? then we need to disable the rendering..
 520
 521
 522         </span><span class="jsdoc-keyword">var </span><span class="jsdoc-var">cfg </span><span class="jsdoc-syntax">={
 523             </span><span class="jsdoc-var">tag</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'h5'</span><span class="jsdoc-syntax">,
 524             </span><span class="jsdoc-var">cls </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'refsynopsisdiv'</span><span class="jsdoc-syntax">,
 525             </span><span class="jsdoc-var">cn </span><span class="jsdoc-syntax">: [
 526                 {
 527                     </span><span class="jsdoc-var">cls</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'funcsynopsis'</span><span class="jsdoc-syntax">,
 528                     </span><span class="jsdoc-var">cn</span><span class="jsdoc-syntax">: [
 529                         {
 530                             </span><span class="jsdoc-var">tag</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'p'</span><span class="jsdoc-syntax">,
 531                             </span><span class="jsdoc-var">cn</span><span class="jsdoc-syntax">: {
 532                                 </span><span class="jsdoc-var">tag</span><span class="jsdoc-syntax">:</span><span class="jsdoc-string">'code'</span><span class="jsdoc-syntax">,
 533                                 </span><span class="jsdoc-var">cls </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'funcprototype'</span><span class="jsdoc-syntax">,
 534                                 </span><span class="jsdoc-var">cn</span><span class="jsdoc-syntax">: [
 535                                     </span><span class="jsdoc-var">this.returntype </span><span class="jsdoc-syntax">+ </span><span class="jsdoc-string">' ' </span><span class="jsdoc-syntax">+ </span><span class="jsdoc-var">nmp</span><span class="jsdoc-syntax">,
 536                                     {
 537                                         </span><span class="jsdoc-var">tag</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'strong'</span><span class="jsdoc-syntax">,
 538                                         </span><span class="jsdoc-var">cls </span><span class="jsdoc-syntax">: </span><span class="jsdoc-var">this.stype</span><span class="jsdoc-syntax">,
 539                                         </span><span class="jsdoc-var">html </span><span class="jsdoc-syntax">: </span><span class="jsdoc-var">this.name
 540                                     </span><span class="jsdoc-syntax">},
 541                                     </span><span class="jsdoc-string">'('</span><span class="jsdoc-syntax">,
 542                                     {
 543                                         </span><span class="jsdoc-var">tag</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'span'</span><span class="jsdoc-syntax">,
 544                                         </span><span class="jsdoc-var">cls </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'roo-params'
 545                                     </span><span class="jsdoc-syntax">},
 546                                     </span><span class="jsdoc-string">')'
 547                                 </span><span class="jsdoc-syntax">]
 548
 549                             }
 550                         }
 551                     ]
 552                 }
 553
 554             ]
 555         };
 556
 557
 558
 559         </span><span class="jsdoc-keyword">return </span><span class="jsdoc-var">cfg</span><span class="jsdoc-syntax">;
 560     },
 561     </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">)
 562     {
 563
 564
 565         </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">();
 566     }
 567
 568
 569
 570
 571
 572 });
 573
 574
 575
 576  </span><span class="jsdoc-comment">/*
 577  * - LGPL
 578  *
 579  */
 580
 581 /**
 582  * @class Roo.doc.NavCategory
 583  * @extends Roo.bootstrap.Component
 584  * Navigation Category class
 585  * @cfg {string} title
 586  * @cfg {string} name
 587  *
 588  * Represent's an category on the left menu.
 589  * - phpdoc @category elements map the pages to the categories
 590  *   this should be on the left side of the menu, when the
 591  *   contents are loaded, then it can expand this out, and add links
 592  *   for each of the methods.
 593  *
 594  *
 595  *
 596  * @constructor
 597  * Create a new Navigation Category
 598  * @param {Object} config The config object
 599  */
 600
 601 </span><span class="jsdoc-var">Roo.doc.NavCategory </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">){
 602     </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">);
 603 };
 604
 605 </span><span class="jsdoc-var">Roo.extend</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">Roo.doc.NavCategory</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">Roo.bootstrap.Component</span><span class="jsdoc-syntax">,  {
 606
 607     </span><span class="jsdoc-var">title </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">''</span><span class="jsdoc-syntax">,
 608     </span><span class="jsdoc-var">name </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">''</span><span class="jsdoc-syntax">,
 609     </span><span class="jsdoc-var">getAutoCreate </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(){
 610
 611         </span><span class="jsdoc-comment">//?? this is the synopsis type....
 612
 613         // this is not very fancy...
 614
 615         </span><span class="jsdoc-keyword">var </span><span class="jsdoc-var">cfg </span><span class="jsdoc-syntax">={
 616
 617             </span><span class="jsdoc-var">cn </span><span class="jsdoc-syntax">: [
 618                 {
 619                     </span><span class="jsdoc-var">tag </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'a'</span><span class="jsdoc-syntax">,
 620                     </span><span class="jsdoc-var">href </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">,
 621                     </span><span class="jsdoc-var">html </span><span class="jsdoc-syntax">: </span><span class="jsdoc-var">this.title
 622                 </span><span class="jsdoc-syntax">},
 623                 {
 624                     </span><span class="jsdoc-var">cls </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'container roo-child-ctr'
 625                 </span><span class="jsdoc-syntax">}
 626             ]
 627         };
 628
 629         </span><span class="jsdoc-keyword">return </span><span class="jsdoc-var">cfg</span><span class="jsdoc-syntax">;
 630     },
 631     </span><span class="jsdoc-var">getChildContainer </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">()
 632     {
 633         </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-child-ctr'</span><span class="jsdoc-syntax">)</span><span class="jsdoc-var">.first</span><span class="jsdoc-syntax">();
 634     }
 635
 636
 637
 638 });
 639
 640
 641
 642  </span></code></body></html>