* @class Roo.doc.Entry
* @extends Roo.bootstrap.Component
* Entry Element class - describes a method etc...
- * @name {String} name of method
- * @purpose {String} short description of method.
+ * @cfg name {String} name of method
+ * @cfg purpose {String} short description of method.
*
* @constructor
* Create a new E
</span><span class="jsdoc-var">marginheight </span><span class="jsdoc-syntax">: 0,
</span><span class="jsdoc-var">offset </span><span class="jsdoc-syntax">: 0
});
- </span><span class="jsdoc-var">Roo.mailer.Body._calls</span><span class="jsdoc-syntax">++;
- </span><span class="jsdoc-keyword">if </span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">Roo.mailer.Body._calls </span><span class="jsdoc-syntax">> 1) {
- </span><span class="jsdoc-keyword">throw </span><span class="jsdoc-string">"test"</span><span class="jsdoc-syntax">;
- }
+
+
</span><span class="jsdoc-comment">// call onRender once... and block next call...?
</span><span class="jsdoc-var">this.onRender</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">body</span><span class="jsdoc-syntax">);
- </span><span class="jsdoc-var">this.onRender </span><span class="jsdoc-syntax">= </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">() { };
+ </span><span class="jsdoc-var">this.el </span><span class="jsdoc-syntax">= </span><span class="jsdoc-var">body</span><span class="jsdoc-syntax">;
+ </span><span class="jsdoc-comment">//this.onRender = function() { };
-};
+</span><span class="jsdoc-syntax">};
</span><span class="jsdoc-var">Roo.doc.Entry._calls </span><span class="jsdoc-syntax">= 0;
</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">)
{
</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">);
- }
-
+ },
+ </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">)
+ {
+
+ </span><span class="jsdoc-var">Roo.doc.Entry._calls</span><span class="jsdoc-syntax">++;
+ </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">> 1 || !</span><span class="jsdoc-var">ct</span><span class="jsdoc-syntax">) {
+ </span><span class="jsdoc-keyword">return</span><span class="jsdoc-syntax">;
+ }
+
+ </span><span class="jsdoc-comment">// call onRender once... and block next call...?
+ </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">);
+ }
});
/**
* @class Roo.doc.Example
- * @extends Roo.bootstrap.Example
+ * @extends Roo.bootstrap.Component
* Example Element class
+ * @cfg {String} title short title describing example
* @cfg {String} lang (phpcode|programlisting) section type.
- * @cfg {String} code
+ * @cfg {String} code example code
+ * @cfg {String} output The expected output from the code
*
*
* @constructor
</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">, {
-
+ </span><span class="jsdoc-var">title </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">''</span><span class="jsdoc-syntax">,
</span><span class="jsdoc-var">lang</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'php'</span><span class="jsdoc-syntax">,
</span><span class="jsdoc-var">code </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">''</span><span class="jsdoc-syntax">,
+ </span><span class="jsdoc-var">output </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">''</span><span class="jsdoc-syntax">,
</span><span class="jsdoc-var">getAutoCreate </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(){
</span><span class="jsdoc-comment">// no colour highlighting in here....
</span><span class="jsdoc-keyword">var </span><span class="jsdoc-var">cfg </span><span class="jsdoc-syntax">={
-
- </span><span class="jsdoc-var">cls </span><span class="jsdoc-syntax">: </span><span class="jsdoc-var">this.lang</span><span class="jsdoc-syntax">,
-
+ </span><span class="jsdoc-var">cls </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'panel panel-info'</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">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">'<br/>'</span><span class="jsdoc-syntax">)
+ </span><span class="jsdoc-var">cls </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'panel-heading'</span><span class="jsdoc-syntax">,
+ </span><span class="jsdoc-var">html </span><span class="jsdoc-syntax">: </span><span class="jsdoc-var">this.title
+ </span><span class="jsdoc-syntax">},
+ {
+ </span><span class="jsdoc-var">cls </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'panel-body'</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">'pre'</span><span class="jsdoc-syntax">,
+ </span><span class="jsdoc-var">cls </span><span class="jsdoc-syntax">: </span><span class="jsdoc-var">this.lang</span><span class="jsdoc-syntax">,
+ </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">'<br/>'</span><span class="jsdoc-syntax">)
+ }
+ ]
}
]
};
+ </span><span class="jsdoc-keyword">if </span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">this.output</span><span class="jsdoc-syntax">) {
+ </span><span class="jsdoc-var">cfg.cn.push</span><span class="jsdoc-syntax">(
+
+ {
+ </span><span class="jsdoc-var">cls </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'panel-footer'</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">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">'<br/>'</span><span class="jsdoc-syntax">)
+ }
+ }
+
+
+ );
+ }
+
+
</span><span class="jsdoc-keyword">return </span><span class="jsdoc-var">cfg</span><span class="jsdoc-syntax">;
}
* @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
*
</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">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">this.desc
+ </span><span class="jsdoc-syntax">]
+ }
+ ]
+ };
+
+
}
+
</span><span class="jsdoc-var">getAutoCreate </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">cfg </span><span class="jsdoc-syntax">={
</span><span class="jsdoc-var">cls </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'refsection'</span><span class="jsdoc-syntax">,
</span><span class="jsdoc-comment">// id... ?
</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">'h1'</span><span class="jsdoc-syntax">,
+ </span><span class="jsdoc-var">tag</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'h3'</span><span class="jsdoc-syntax">,
</span><span class="jsdoc-var">cls </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'title'</span><span class="jsdoc-syntax">,
- </span><span class="jsdoc-var">html </span><span class="jsdoc-syntax">: </span><span class="jsdoc-var">this.stype.charAt</span><span class="jsdoc-syntax">(0)</span><span class="jsdoc-var">.toUpperCase</span><span class="jsdoc-syntax">() + </span><span class="jsdoc-var">this.stype.slice</span><span class="jsdoc-syntax">(1) </span><span class="jsdoc-comment">//ucfirst
- </span><span class="jsdoc-syntax">}
+ </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">]
+ }
]
};
</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">) {
</span><span class="jsdoc-comment">// db package uses variable list here... - it results in dd/dl but the layout is messed up..
- </span><span class="jsdoc-var">cfg.cn.push</span><span class="jsdoc-syntax">({
+
+ </span><span class="jsdoc-keyword">var </span><span class="jsdoc-var">ul </span><span class="jsdoc-syntax">= {
</span><span class="jsdoc-var">tag</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'ul'</span><span class="jsdoc-syntax">,
- </span><span class="jsdoc-var">cls</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'itemizedlist roo-params'
- </span><span class="jsdoc-syntax">});
+ </span><span class="jsdoc-var">cls</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'itemizedlist roo-params'</span><span class="jsdoc-syntax">,
+ </span><span class="jsdoc-var">cn </span><span class="jsdoc-syntax">: []
+ };
+ </span><span class="jsdoc-comment">// might not have any..
+ </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">;
+ </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">< </span><span class="jsdoc-var">params.length</span><span class="jsdoc-syntax">;</span><span class="jsdoc-var">i</span><span class="jsdoc-syntax">++) {
+ </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">() )
+ }
+
+
+ </span><span class="jsdoc-var">cfg.cn.push</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">ul</span><span class="jsdoc-syntax">);
}
});
-
- </span><span class="jsdoc-comment">/*
+</span><span class="jsdoc-var">Roo.doc.Section.map </span><span class="jsdoc-syntax">= {
+ </span><span class="jsdoc-string">'desc' </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'Description'</span><span class="jsdoc-syntax">,
+ </span><span class="jsdoc-string">'parameter' </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'Parameters'</span><span class="jsdoc-syntax">,
+ </span><span class="jsdoc-string">'return' </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'Return Value'</span><span class="jsdoc-syntax">,
+ </span><span class="jsdoc-string">'note' </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'Notes'</span><span class="jsdoc-syntax">,
+ </span><span class="jsdoc-string">'example' </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'Examples'
+</span><span class="jsdoc-syntax">}
+</span><span class="jsdoc-comment">/*
* - LGPL
*
*/
* @cfg {String} returntype return value
* @cfg {String} name title really..
* @cfg {String} stype (function|constant)
+ * @cfg {String} memberof class name
+ * @cfg {bool} is_static is a static member
*
* @constructor
* Create a new Synopsis
</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">, {
-
+ </span><span class="jsdoc-var">memberof </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">''</span><span class="jsdoc-syntax">,
+ </span><span class="jsdoc-var">is_static </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">false</span><span class="jsdoc-syntax">,
</span><span class="jsdoc-var">returntype </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">''</span><span class="jsdoc-syntax">,
</span><span class="jsdoc-var">name</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">''</span><span class="jsdoc-syntax">,
</span><span class="jsdoc-var">stype</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'function'</span><span class="jsdoc-syntax">,
</span><span class="jsdoc-var">getAutoCreate </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">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...
+ </span><span class="jsdoc-var">Roo.log</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">this.items</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">'h2'</span><span class="jsdoc-syntax">,
+ </span><span class="jsdoc-var">tag</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'h5'</span><span class="jsdoc-syntax">,
</span><span class="jsdoc-var">cls </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'refsynopsisdiv'</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">'span'</span><span class="jsdoc-syntax">,
</span><span class="jsdoc-var">cls </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'roo-params'
- </span><span class="jsdoc-syntax">}
- ]
+ </span><span class="jsdoc-syntax">},
+ </span><span class="jsdoc-string">')'
+ </span><span class="jsdoc-syntax">]
}
}