API

Class

<%= class_.name %>

继承自<%= class_.extend %>。

<%= class_.description %>

Options

new <%= class_.name %>()

<% if(class_.params.length) { %> <% class_.params.forEach(function(param) { %> <% }); %> <% } else { %> <% } %>
参数类型默认值数据流向描述
<%= param.name %><%- param.type %><% if(param.default_) { %><%= param.default_ %><% } %><% if(param.bindWay !== ' = ') { %>outside <%= param.bindWay %> inside<% } else { %><% } %><%= param.description %>
无参数
<% if(methods.length) { %>

Methods

<% methods.forEach(function(method) { %> <% if(method.ignore) return; %>

<% if(method.deprecated) { %>@deprecated <% } %><%= class_.lowerName %>.<%= method.name %>(<%= method.body %>)

<%= method.description %>

<% if(method.params.length) { %> <% method.params.forEach(function(param) { %> <% }); %> <% } else { %> <% } %> <% if(method.return_ && method.return_.type !== 'void') { %> <% } else { %> <% } %>
参数类型默认值描述
<%= param.name %><%- param.type %><% if(param.default_) { %><%= param.default_ %><% } %><%= param.description %>
无参数
返回值类型描述
<%= method.return_.name %><%- method.return_.type %><%= method.return_.description %>
无返回值
<% }); %> <% } %>
<% if(staticMethods.length) { %>

Static Methods

<% staticMethods.forEach(function(method) { %> <% if(method.ignore) return; %>

<% if(method.deprecated) { %>@deprecated <% } %><%= class_.name %>.<%= method.name %>(<%= method.body %>)

<%= method.description %>

<% if(method.params.length) { %> <% method.params.forEach(function(param) { %> <% }); %> <% } else { %> <% } %> <% if(method.return_ && method.return_.type !== 'void') { %> <% } else { %> <% } %>
参数类型默认值描述
<%= param.name %><%- param.type %><% if(param.default_) { %><%= param.default_ %><% } %><%= param.description %>
无参数
返回值类型描述
<%= method.return_.name %><%- method.return_.type %><%= method.return_.description %>
无返回值
<% }); %> <% } %>
<% if(inheritedMethods.length) { %>

Inherited Methods

<% inheritedMethods.forEach(function(method) { %> <% if(method.ignore) return; %> <% if(!method.overridden) { %>

<% if(method.deprecated) { %>@deprecated <% } %><%= class_.lowerName %>.<%= method.name %>(<%= method.body %>)

<%= method.description %>

<% if(method.params.length) { %> <% method.params.forEach(function(param) { %> <% }); %> <% } else { %> <% } %> <% if(method.return_ && method.return_.type !== 'void') { %> <% } else { %> <% } %>
参数类型默认值描述
<%= param.name %><%- param.type %><% if(param.default_) { %><%= param.default_ %><% } %><%= param.description %>
无参数
返回值类型描述
<%= method.return_.name %><%- method.return_.type %><%= method.return_.description %>
无返回值
<% } else { %>

@override <%= class_.lowerName %>.<%= method.name %>(<%= method.body %>)

<% } %> <% }); %> <% } %>
<% if(events.length) { %>

Events

<% events.forEach(function(event) { %> <% if(event.ignore) return; %>

<%= class_.lowerName %>.$on('<%= event.name %>')

<%= event.description %>

<% if(event.properties.length) { %> <% event.properties.forEach(function(property) { %> <% }); %> <% } else { %> <% } %>
属性类型描述
<%= property.name %><%- property.type %><%= property.description %>
无属性
<% }); %> <% } %>
<% if(inheritedEvents.length) { %>

Inherited Events

<% inheritedEvents.forEach(function(event) { %> <% if(event.ignore) return; %> <% if(!event.overridden) { %>

<%= class_.lowerName %>.$on('<%= event.name %>')

<%= event.description %>

<% if(event.properties.length) { %> <% event.properties.forEach(function(property) { %> <% }); %> <% } else { %> <% } %>
属性类型描述
<%= property.name %><%- property.type %><%= property.description %>
无属性
<% } else { %>

@override <%= class_.lowerName %>.$on('<%= event.name %>')

<% } %> <% }); %> <% } %>