scratchfoundation/paper.js
1
0
Fork 0
mirror of https://github.com/scratchfoundation/paper.js.git synced 2025-01-07 13:22:07 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

jsdoc: add methods and properties from inherited classes.

Browse source
This commit is contained in:
Jonathan Puckey 2011-05-27 14:59:43 +02:00
parent 8887a4494c
commit f9d9847320
2 changed files with 50 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

51
build/jsdoc-toolkit/templates/jsdoc/class.tmpl
View file

@ -15,6 +15,31 @@
operators[name].push(operator); operators[name].push(operator);
} }
} }
var inheritedProperties = data.properties.filter(function($) {return $.memberOf != data.alias});
var inheritedMethods = data.methods.filter(function($) {return $.memberOf != data.alias});
var inheritedClasses = {};
var inheritedClassLinks = [];
inheritedProperties.concat(inheritedMethods).map(function($) {
if (!inheritedClasses[$.memberOf]) {
inheritedClassLinks.push(new Link().toSymbol($.memberOf));
inheritedClasses[$.memberOf] = {
className: $.memberOf,
properties: [],
methods: []
};
}
});
for (var i = 0, l = inheritedProperties.length; i < l; i++) {
var symbol = inheritedProperties[i];
inheritedClasses[symbol.memberOf].properties.push(symbol);
}
for (var i = 0, l = inheritedMethods.length; i < l; i++) {
var symbol = inheritedMethods[i];
inheritedClasses[symbol.memberOf].methods.push(symbol);
}
!} !}
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html> <html>
@ -31,6 +56,9 @@
<body class="reference"> <body class="reference">
<div class="reference-class"> <div class="reference-class">
<h1>{+data.alias+}</h1> <h1>{+data.alias+}</h1>
<if test="inheritedClassLinks.length">
<p> Extends {+ inheritedClassLinks.join(', ') +}</p>
</if>
<p>{+processInlineTags(data.classDesc)+}</p> <p>{+processInlineTags(data.classDesc)+}</p>
</div> </div>
<!-- ============================== constructors ========================= --> <!-- ============================== constructors ========================= -->
@ -93,10 +121,6 @@
<if test="defined(ownMethods) && ownMethods.length"> <if test="defined(ownMethods) && ownMethods.length">
<div class="reference-members"><h2>Functions</h2> <div class="reference-members"><h2>Functions</h2>
<for each="member" in="ownMethods"> <for each="member" in="ownMethods">
{! member.desc = processGroupTitle(member.desc, member) !}
<if test="defined(member.groupTitle)">
<h3>{+member.groupTitle+}</h3>
</if>
{+ templates.method.process(member) +} {+ templates.method.process(member) +}
</for> </for>
</div> </div>
@ -108,5 +132,22 @@
</for> </for>
</div> </div>
</if> </if>
<for each="inheritedClass" in="inheritedClasses">
<!-- ============================== properties ========================= -->
<if test="inheritedClass.properties.length">
<div class="reference-members"><h2>Inherited properties from {+ new Link().toSymbol(inheritedClass.className) +}</h2>
<for each="member" in="inheritedClass.properties">
{+ templates.property.process(member) +}
</for>
</div>
</if>
<!-- ============================== properties ========================= -->
<if test="inheritedClass.methods.length">
<div class="reference-members"><h2>Inherited functions from {+ new Link().toSymbol(inheritedClass.className) +}</h2>
<for each="member" in="inheritedClass.methods">
{+ templates.method.process(member) +}
</for>
</div>
</if>
</for>
</body> </body>

5
build/jsdoc-toolkit/templates/jsdoc/method.tmpl
View file

@ -1,10 +1,13 @@
{! {!
data.desc = processGroupTitle(data.desc, data);
var memberId = Helpers.getSymbolId(data); var memberId = Helpers.getSymbolId(data);
var functionTitle = '<b>' + data.name.replace(/\^\d+$/, '') + '</b>' + makeSignature(data.params); var functionTitle = '<b>' + data.name.replace(/\^\d+$/, '') + '</b>' + makeSignature(data.params);
if (data.isStatic) if (data.isStatic)
functionTitle = '<b>' + data.memberOf + '.</b>' + functionTitle; functionTitle = '<b>' + data.memberOf + '.</b>' + functionTitle;
!} !}
<if test="defined(data.groupTitle)">
<h3>{+data.groupTitle+}</h3>
</if>
<div id="{+ memberId +}" class="member"> <div id="{+ memberId +}" class="member">
<div id="{+ memberId +}-link" class="member-link"> <div id="{+ memberId +}-link" class="member-link">
<a name="{+ memberId +}" href="#" onClick="return toggleMember('{+ memberId +}', false);"><tt>{+ functionTitle +}</tt></a> <a name="{+ memberId +}" href="#" onClick="return toggleMember('{+ memberId +}', false);"><tt>{+ functionTitle +}</tt></a>