Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(173)

Side by Side Diff: documentation/jsdoc-toolkit-templates/class.tmpl

Issue 147079: This CL contains the the changes needed to build... (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src/o3d/
Patch Set: '' Created 11 years, 5 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch | Annotate | Revision Log
OLDNEW
1 {! 1 {!
2 thisClass = data; 2 thisClass = data;
3 !} 3 !}
4 4
5 <!-- ============================== header ================================= --> 5 <!-- ============================== header ================================= -->
6 <!-- begin static/header.html --> 6 <!-- begin static/header.html -->
7 {+include("static/header.html")+} 7 {+include("static/header.html")+}
8 <!-- end static/header.html --> 8 <!-- end static/header.html -->
9 9
10 <div id="doxygen-ref"> 10 <div id="doxygen-ref">
(...skipping 21 matching lines...) Expand all
32 <h2>Source</h2> 32 <h2>Source</h2>
33 <a name="_source" href="http://code.google.com/p/o3d/source/browse/trunk/samples /{+getSourcePath(thisClass)+}">{+getSourcePath(thisClass)+}</a> 33 <a name="_source" href="http://code.google.com/p/o3d/source/browse/trunk/samples /{+getSourcePath(thisClass)+}">{+getSourcePath(thisClass)+}</a>
34 </if> 34 </if>
35 35
36 <!-- =========== SEE ALSO =========== --> 36 <!-- =========== SEE ALSO =========== -->
37 <if test="data.see.length"> 37 <if test="data.see.length">
38 <h2>See Also</h2> 38 <h2>See Also</h2>
39 <ul> 39 <ul>
40 <for each="seeAlso" in="data.see"> 40 <for each="seeAlso" in="data.see">
41 <li> 41 <li>
42 {+linkifyTypeSpec(seeAlso)+} 42 {+linkifyTypeSpec(makeName('[Class See Also]', thisClass.alias), seeAlso)+}
43 </li> 43 </li>
44 </for> 44 </for>
45 </ul> 45 </ul>
46 </if> 46 </if>
47 47
48 <!-- =========== SEE ALSO =========== --> 48 <!-- =========== SEE ALSO =========== -->
49 49
50 <!-- ========== CONSTRUCTOR SUMMARY ============== --> 50 <!-- ========== CONSTRUCTOR SUMMARY ============== -->
51 <if test="!data.isPrivate && !data.isBuiltin() && !data.isNamespace && data.is(' CONSTRUCTOR')"> 51 <if test="!data.isPrivate && !data.isBuiltin() && !data.isNamespace && data.is(' CONSTRUCTOR')">
52 <h2>Constructor</h2> 52 <h2>Constructor</h2>
53 <ul> 53 <ul>
54 <li><a class="el" href="{+data.name+}">{+data.alias+}</a><if test="data.classT ype != 'Namespace '">{+ makeSignature(data.params) +}</if></li> 54 <li><a class="el" href="{+data.name+}">{+data.alias+}</a><if test="data.classT ype != 'Namespace '">{+ makeSignature(data.params) +}</if></li>
55 </ul> 55 </ul>
56 </if> 56 </if>
57 57
58 <!-- ========== METHOD SUMMARY =========== --> 58 <!-- ========== METHOD SUMMARY =========== -->
59 <if test="thisClass.methods.length"> 59 <if test="thisClass.methods.length">
60 {! var ownMethods = data.methods.sort(makeSortby("name")); !} 60 {! var ownMethods = data.methods.sort(makeSortby("name")); !}
61 <if test="ownMethods.length"> 61 <if test="ownMethods.length">
62 <h2>Public Member Functions</h2> 62 <h2>Public Member Functions</h2>
63 <ul> 63 <ul>
64 <for each="method" in="ownMethods"> 64 <for each="method" in="ownMethods">
65 <if test="!method.isPrivate"> 65 <if test="!method.isPrivate">
66 <li> 66 <li>
67 <if test="method.isStatic||!method.memberOf">&lt;static&gt; </if> 67 <if test="method.isStatic||!method.memberOf">&lt;static&gt; </if>
68 <if test="method.type.length">{+linkifyTypeSpec(method.type)+}&nbsp;</if > 68 <if test="method.type.length">{+linkifyTypeSpec(makeName('[Method Summar y]', thisClass.alias, method.name), method.type)+}&nbsp;</if>
69 <a class="el" href="#{+method.name+}">{+method.name+}</a>{+makeSignature (method.params)+} 69 <a class="el" href="#{+method.name+}">{+method.name+}</a>{+makeSignature (method.params)+}
70 </li> 70 </li>
71 </if> 71 </if>
72 </for> 72 </for>
73 </ul> 73 </ul>
74 </if> 74 </if>
75 </if> 75 </if>
76 76
77 <!-- =========== FIELD SUMMARY =========== --> 77 <!-- =========== FIELD SUMMARY =========== -->
78 <if test="data.properties.length"> 78 <if test="data.properties.length">
79 {! var ownProperties = data.properties.sort(makeSortby("name")); !} 79 {! var ownProperties = data.properties.sort(makeSortby("name")); !}
80 <if test="ownProperties.length"> 80 <if test="ownProperties.length">
81 <h2>Public Properties</h2> 81 <h2>Public Properties</h2>
82 <ul> 82 <ul>
83 <for each="property" in="ownProperties"> 83 <for each="property" in="ownProperties">
84 <if test="!property.isPrivate"> 84 <if test="!property.isPrivate">
85 <li> 85 <li>
86 <if test="property.isStatic||!property.memberOf">&lt;static&gt;&nbsp;</if> 86 <if test="property.isStatic||!property.memberOf">&lt;static&gt;&nbsp;</if>
87 {+linkifyTypeSpec(getPropertyType(property))+} 87 {+linkifyTypeSpec(makeName('[Property Summary]', thisClass.alias, property .name), getPropertyType(property))+}
88 <a class="el" href="#{+property.name+}">{+property.name+}</a> 88 <a class="el" href="#{+property.name+}">{+property.name+}</a>
89 </li> 89 </li>
90 </if> 90 </if>
91 </for> 91 </for>
92 </ul> 92 </ul>
93 </if> 93 </if>
94 </if> 94 </if>
95 95
96 <!-- =========== END FIELD SUMMARY =========== --> 96 <!-- =========== END FIELD SUMMARY =========== -->
97 97
98 <!-- ========== CONSTRUCTOR DETAIL ============== --> 98 <!-- ========== CONSTRUCTOR DETAIL ============== -->
99 <if test="!data.isPrivate && !data.isBuiltin() && !data.isNamespace && data.is(' CONSTRUCTOR')"> 99 <if test="!data.isPrivate && !data.isBuiltin() && !data.isNamespace && data.is(' CONSTRUCTOR')">
100 <hr/> 100 <hr/>
101 <h2>Constructor</h2> 101 <h2>Constructor</h2>
102 <a class="anchor" name="{+data.name+}"></a> 102 <a class="anchor" name="{+data.name+}"></a>
103 <div class="memitem"> 103 <div class="memitem">
104 <div class="memproto"> 104 <div class="memproto">
105 <table class="memname"> 105 <table class="memname">
106 <if test="data.params && data.params.length"> 106 <if test="data.params && data.params.length">
107 {! 107 {!
108 var tempCSS = "memname"; 108 var tempCSS = "memname";
109 var tempName = data.alias; 109 var tempName = data.alias;
110 var tempParen = "("; 110 var tempParen = "(";
111 var tempEnd = data.params.length > 1 ? "" : ")" 111 var tempEnd = data.params.length > 1 ? "" : ")"
112 !} 112 !}
113 <for each="param" in="data.params"> 113 <for each="param" in="data.params">
114 <tr> 114 <tr>
115 <td class="{+tempCSS+}">{+tempName+}</td> 115 <td class="{+tempCSS+}">{+tempName+}</td>
116 <td>{+tempParen+}</td> 116 <td>{+tempParen+}</td>
117 <td class="paramtype">{+linkifyTypeSpec(param.type)+}</td> 117 <td class="paramtype">{+linkifyTypeSpec(makeName('[Constructor Param]', th isClass.alias, param.name), param.type)+}</td>
118 <td class="paramname"><em>{+param.name+}</em></td> 118 <td class="paramname"><em>{+param.name+}</em></td>
119 <td><if test="$param_last">)</if></td> 119 <td><if test="$param_last">)</if></td>
120 <td></td> 120 <td></td>
121 </tr> 121 </tr>
122 {! 122 {!
123 tempCSS = "paramkey"; 123 tempCSS = "paramkey";
124 tempName = ""; 124 tempName = "";
125 tempParen = ""; 125 tempParen = "";
126 !} 126 !}
127 </for> 127 </for>
(...skipping 37 matching lines...) Expand 10 before | Expand all | Expand 10 after
165 <for each="member" in="ownMethods"> 165 <for each="member" in="ownMethods">
166 <if test="!member.isPrivate"> 166 <if test="!member.isPrivate">
167 <a class="anchor" name="{+member.name+}"></a> 167 <a class="anchor" name="{+member.name+}"></a>
168 <div class="memitem"> 168 <div class="memitem">
169 <div class="memproto"> 169 <div class="memproto">
170 <table class="memname"> 170 <table class="memname">
171 {! var tempInherited = member.memberOf == thisClass.alias ? "" : "[[]inh erited]"; !} 171 {! var tempInherited = member.memberOf == thisClass.alias ? "" : "[[]inh erited]"; !}
172 <if test="member.params && member.params.length"> 172 <if test="member.params && member.params.length">
173 {! 173 {!
174 var tempCSS = "memname"; 174 var tempCSS = "memname";
175 var tempName = linkifyTypeSpec(member.type)+" "+member.memberOf+"."+mem ber.name; 175 var tempName = linkifyTypeSpecForReturn(makeName('[Method Detail]', thi sClass.alias, member.name), member.type)+" "+member.memberOf+"."+member.name;
176 var tempParen = "("; 176 var tempParen = "(";
177 var tempEnd = member.params.length > 1 ? "" : ")" 177 var tempEnd = member.params.length > 1 ? "" : ")"
178 !} 178 !}
179 <for each="param" in="member.params"> 179 <for each="param" in="member.params">
180 <tr> 180 <tr>
181 <td class="{+tempCSS+}">{+tempName+}</td> 181 <td class="{+tempCSS+}">{+tempName+}</td>
182 <td>{+tempParen+}</td> 182 <td>{+tempParen+}</td>
183 <td class="paramtype">{+linkifyTypeSpec(param.type)+}</td> 183 <td class="paramtype">{+linkifyTypeSpec(makeName('[Param Detail]', thi sClass.alias, member.name, param.name), param.type)+}</td>
184 <td class="paramname"><em>{+param.name+}</em></td> 184 <td class="paramname"><em>{+param.name+}</em></td>
185 <td><if test="$param_last">)</if></td> 185 <td><if test="$param_last">)</if></td>
186 <td><if test="$param_last">{+tempInherited+}</if></td> 186 <td><if test="$param_last">{+tempInherited+}</if></td>
187 </tr> 187 </tr>
188 {! 188 {!
189 tempCSS = "paramkey"; 189 tempCSS = "paramkey";
190 tempName = ""; 190 tempName = "";
191 tempParen = ""; 191 tempParen = "";
192 !} 192 !}
193 </for> 193 </for>
(...skipping 21 matching lines...) Expand all
215 <for each="param" in="member.params"> 215 <for each="param" in="member.params">
216 <tr><td valign="top"></td><td valign="top"><em>{+param.name+}</em></td ><td>{+sanitizeForEZT(param.desc)+}</td></tr> 216 <tr><td valign="top"></td><td valign="top"><em>{+param.name+}</em></td ><td>{+sanitizeForEZT(param.desc)+}</td></tr>
217 </for> 217 </for>
218 </table> 218 </table>
219 </dd> 219 </dd>
220 </dl> 220 </dl>
221 </if> 221 </if>
222 <if test="member.type && member.type.length"> 222 <if test="member.type && member.type.length">
223 <dl class="return" compact><dt><b>Returns:</b></dt> 223 <dl class="return" compact><dt><b>Returns:</b></dt>
224 <dd> 224 <dd>
225 {+linkifyTypeSpec(member.type)+}.<if test="member.returns && member.returns. length">{+sanitizeForEZT(member.returns[0].desc)+}</if> 225 {+linkifyTypeSpec(makeName('[Return detail]', thisClass.alias, member.name), member.type)+}.<if test="member.returns && member.returns.length">{+sanitizeFor EZT(member.returns[0].desc)+}</if>
226 </dd> 226 </dd>
227 </if> 227 </if>
228 </div> 228 </div>
229 229
230 <if test="member.see.length"> 230 <if test="member.see.length">
231 <dl compact><td><b>See Also:</b></dt> 231 <dl compact><td><b>See Also:</b></dt>
232 <dd><ul> 232 <dd><ul>
233 <for each="seeAlso" in="member.see"> 233 <for each="seeAlso" in="member.see">
234 <li> 234 <li>
235 {+linkifyTypeSpec(seeAlso)+} 235 {+linkifyTypeSpec(makeName('[Method See Also]', thisClass.alias, '[See A lso]'), seeAlso)+}
236 </li> 236 </li>
237 </for> 237 </for>
238 </ul></dd> 238 </ul></dd>
239 </dl> 239 </dl>
240 </if> 240 </if>
241 241
242 </div> 242 </div>
243 </if> 243 </if>
244 </for> 244 </for>
245 </if> 245 </if>
246 246
247 <!-- =========== PROPERTY DETAIL ============== --> 247 <!-- =========== PROPERTY DETAIL ============== -->
248 248
249 <if test="defined(ownProperties) && ownProperties.length"> 249 <if test="defined(ownProperties) && ownProperties.length">
250 <hr/> 250 <hr/>
251 <h2>Member Property Documentation</h2> 251 <h2>Member Property Documentation</h2>
252 <for each="property" in="ownProperties"> 252 <for each="property" in="ownProperties">
253 <if test="!property.isPrivate"> 253 <if test="!property.isPrivate">
254 <a class="anchor" name="{+property.name+}"></a> 254 <a class="anchor" name="{+property.name+}"></a>
255 <div class="memitem"> 255 <div class="memitem">
256 <div class="memproto"> 256 <div class="memproto">
257 <table class="memname"> 257 <table class="memname">
258 <tr> 258 <tr>
259 <td class="memname">{+linkifyTypeSpec(getPropertyType(property))+} {+p roperty.memberOf+"."+property.name+}</td> 259 <td class="memname">{+linkifyTypeSpec(makeName('[Property Detail]', th isClass.alias, property.name), getPropertyType(property))+} {+property.memberOf+ "."+property.name+}</td>
260 </tr> 260 </tr>
261 </table> 261 </table>
262 </div> 262 </div>
263 263
264 <div class="memdoc"> 264 <div class="memdoc">
265 <p/> 265 <p/>
266 {+sanitizeForEZT(property.desc)+} 266 {+sanitizeForEZT(property.desc)+}
267 </div> 267 </div>
268 268
269 <if test="property.see.length"> 269 <if test="property.see.length">
270 <dl compact><td><b>See Also:</b></dt> 270 <dl compact><td><b>See Also:</b></dt>
271 <dd><ul> 271 <dd><ul>
272 <for each="seeAlso" in="property.see"> 272 <for each="seeAlso" in="property.see">
273 <li> 273 <li>
274 {+linkifyTypeSpec(seeAlso)+} 274 {+linkifyTypeSpec(makeName('[Property See Also]', thisClass.alias), seeA lso)+}
275 </li> 275 </li>
276 </for> 276 </for>
277 </ul></dd> 277 </ul></dd>
278 </dl> 278 </dl>
279 </if> 279 </if>
280 280
281 </div> 281 </div>
282 </if> 282 </if>
283 </for> 283 </for>
284 </if> 284 </if>
285 285
286 </div><!-- end contents --> 286 </div><!-- end contents -->
287 </div><!-- end doxygen-ref --> 287 </div><!-- end doxygen-ref -->
288 288
289 <!-- ============================== footer ================================= --> 289 <!-- ============================== footer ================================= -->
290 <!-- begin static/footer.html --> 290 <!-- begin static/footer.html -->
291 {+include("static/footer.html")+} 291 {+include("static/footer.html")+}
292 <!-- end static/footer.html --> 292 <!-- end static/footer.html -->
293 293
294 294
OLDNEW
« no previous file with comments | « documentation/externs/o3d-extra-externs.js ('k') | documentation/jsdoc-toolkit-templates/publish.js » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698