git.roojs.org Git - roojs1/blob - Roo/doc/Synopsis.js

   1 /*
   2  * - LGPL
   3  *
   4  */
   5
   6 /**
   7  * @class Roo.doc.Synopsis
   8  * @extends Roo.bootstrap.Component
   9  * Synopsis Element class
  10  * @cfg {String} returntype return value
  11  * @cfg {String} name title really..
  12  * @cfg {String} stype (function|constant)
  13  * @cfg {String} memberof class name
  14  * @cfg {bool} is_static is a static member
  15  *
  16  * @constructor
  17  * Create a new Synopsis
  18  * @param {Object} config The config object
  19  */
  20
  21 Roo.doc.Synopsis = function(config){
  22     Roo.doc.Synopsis.superclass.constructor.call(this, config);
  23 };
  24
  25 Roo.extend(Roo.doc.Synopsis, Roo.bootstrap.Component,  {
  26
  27     memberof : '',
  28     is_static : false,
  29     returntype : '',
  30     name: '',
  31     stype:   'function',
  32
  33     getAutoCreate : function(){
  34
  35         var cfg ={
  36             tag: 'h5',
  37             cls : 'refsynopsisdiv',
  38             cn : [
  39                 {
  40                     cls: 'funcsynopsis',
  41                     cn: [
  42                         {
  43                             tag: 'p',
  44                             cn: {
  45                                 tag:'code',
  46                                 cls : 'funcprototype',
  47                                 cn: [
  48                                     this.returntype + ' ',
  49                                     {
  50                                         tag: 'strong',
  51                                         cls : this.stype,
  52                                         html : this.name
  53                                     },
  54                                     '(',
  55                                     {
  56                                         tag: 'span',
  57                                         cls : 'roo-params'
  58                                     },
  59                                     ')'
  60                                 ]
  61
  62                             }
  63                         }
  64                     ]
  65                 }
  66
  67             ]
  68         };
  69
  70
  71
  72         return cfg;
  73     },
  74     getChildContainer : function(build_call)
  75     {
  76
  77
  78         return this.el.select('.roo-params',true).first();
  79     }
  80
  81
  82
  83
  84
  85 });
  86
  87
  88
  89