git.roojs.org Git - gnome.introspection-doc-generator/blob - docs/references.html

   1
   2
   3   <!-- ============================== methods summary / details ======================== -->
   4
   5
   6   <! --  -->
   7         <!-- constructor?? -->
   8         {!
   9
  10
  11                 var ownMethods = data.sort(makeSortby("memberOf"));
  12                 //var ownMethods = [];
  13                 //ownMethods.push.apply(ownMethods, data.sort(makeSortby("alias")));
  14         //ownMethods.push.apply(ownMethods, data);
  15
  16
  17         !}
  18
  19
  20         <!-- then dynamics first -->
  21
  22
  23
  24     <if test="!ownMethods.length">
  25
  26      <table cellspacing="0" class="member-table">
  27       <caption class="Empty">Used by These Methods / Signals / Properties- Nowhere other than here</caption>
  28      </table>
  29
  30     </if>
  31     <if test="ownMethods.length">
  32
  33
  34
  35
  36       <table cellspacing="0" class="member-table">
  37       <caption>Used by These Methods / Signals / Properties</caption>
  38         <tr>
  39                     <th class="msource-header">Class / Namespace</th>
  40             <th class="sig-header">Method / Signal / Properties</th>
  41
  42
  43         </tr>
  44
  45
  46         <for each="member" in="ownMethods">
  47
  48           <tr class="method-row config-row-alt{+$member_i % 2+}">
  49
  50              <td class="msource">
  51
  52                         {+  new Link().toSymbolLong(member.memberOf) +}
  53             <br/>
  54             {+ member.propertyType +}
  55             <!--<div class="mdesc">
  56                 <div class="short">
  57
  58                 </div>
  59             </div> -->
  60
  61             </td>
  62
  63
  64
  65 <if test="member.propertyType != 'Property'">
  66  <!-- signal or method -->
  67
  68             <td class="sig">
  69                 <a id="{+member.memberOf+}-method-{+member.name+}"   name=".{+member.name+}"></a>
  70                 <div class="fixedFont">
  71                         <span class="attributes">{!
  72                                         if (member.isConstructor) {
  73                                                 output +=  "new  <B>" +
  74                                                      member.memberOf + (!member.name || !member.name.length ? "" : ".") +"</B>";
  75                                         } else {
  76
  77                                                 if (member.isStatic) {
  78                                                         output +=  member.memberOf + ".";
  79                                                 }
  80                                         }
  81                                 !}</span><b class="itemname">{!
  82                                          output += (!member.name || !member.name.length  ? "" : member.name);
  83                                 !}</b>
  84
  85                                  {+makeSignature(member.params)+}
  86
  87                                 <if test="(member.returns && member.returns.length) || !member.isConstructor">
  88                                          :
  89                                         {!
  90                                            if (member.returns.length > 1) {
  91                                                    output += (new Link().toSymbol("Object"));
  92                                            } else {
  93                                                    output += (new Link().toSymbolLong(member.returns[0].type));
  94                                            }
  95
  96                                          !}
  97
  98                                 </if>
  99
 100                 </div>
 101                 <div class="mdesc">
 102                 <if test="!member.isConstructor">
 103                    <div class="short">{+resolveLinks(summarize(member.desc))+}</div>
 104                  </if>
 105                  <if test="member.isConstructor">
 106                         <div class="short">Create a new {+member.memberOf +}</div>
 107                  </if>
 108
 109
 110
 111
 112             </td>
 113 </if>
 114 <!-- property -->
 115
 116 <if test="member.propertyType == 'Property'">
 117  <!-- signal or method -->
 118
 119
 120   <td class="sig">
 121
 122                         <a id="{+member.memberOf+}-cfg-{+member.name+}" name=".{+member.name+}"></a>
 123                         <div class="fixedFont">
 124                                 <b  class="itemname">{+member.name+}</b> : {+((member.type) ? (new Link().toSymbolLong(member.type)) : "" )+}
 125                  {+ (member.flags ? (member.flags & 2 ? '' : 'read only') : '')+}
 126
 127                         </div>
 128
 129                         <div class="mdesc">
 130                             <div class="short">{+resolveLinks(summarize(member.desc))+}</div>
 131                         </div>
 132
 133
 134
 135                     </td>
 136 </if>
 137
 138
 139
 140
 141         </tr>
 142         </for>
 143
 144     </table>
 145 </if>
 146