diff options
Diffstat (limited to 'chrome/common/extensions/docs/template/api_template.html')
| -rw-r--r-- | chrome/common/extensions/docs/template/api_template.html | 69 |
1 files changed, 43 insertions, 26 deletions
diff --git a/chrome/common/extensions/docs/template/api_template.html b/chrome/common/extensions/docs/template/api_template.html index 1b47011..ae5a94d 100644 --- a/chrome/common/extensions/docs/template/api_template.html +++ b/chrome/common/extensions/docs/template/api_template.html @@ -21,7 +21,8 @@ <span class="enum" jsdisplay="enum">enumerated</span> <span id="typeTemplate"> <span jsdisplay="getTypeRef($this)"> - <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)"> Type</a> + <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" + jscontent="getTypeRef($this)"> Type</a> </span> <span jsdisplay="!getTypeRef($this)"> <span jsdisplay="isArray($this)"> @@ -63,6 +64,20 @@ </dl> </dd> + <!-- OBJECT METHODS --> + <dd jsdisplay="$this.type === 'object' && + $this.functions && $this.functions.length > 0" + jsvalues="$scope:id"> + <div transclude="methodsTemplate"></div> + </dd> + + <!-- OBJECT EVENT FIELDS --> + <dd jsdisplay="$this.type === 'object' && + $this.events && $this.events.length > 0" + jsvalues="$scope:id"> + <div transclude="eventsTemplate"></div> + </dd> + <!-- FUNCTION PARAMETERS --> <dd jsdisplay="isFunction($this) && $this.parameters && $this.name != 'callback'"> @@ -257,23 +272,23 @@ </ol> </li> <li jsdisplay="functions && functions.length > 0"> - <a href="#methods">Methods</a> + <a jsvalues=".href:'#' + getAnchorName('global', 'methods')">Methods</a> <ol> <li jsselect="functions.sort(sortByName)" jsdisplay="!($this.nodoc)"> <a jscontent="name" - jsvalues=".href:'#method-' + name" + jsvalues=".href:'#' + getAnchorName('method', name)" href="#method-anchor">methodName</a> </li> </ol> </li> <li jsdisplay="events && events.length > 0"> - <a href="#events">Events</a> + <a jsvalues=".href:'#' + getAnchorName('global', 'events')">Events</a> <ol> <li jsselect="events.sort(sortByName)" jsdisplay="!($this.nodoc)"> <a jscontent="name" - jsvalues=".href:'#event-' + name" + jsvalues=".href:'#' + getAnchorName('event', name)" href="#event-anchor">eventName</a> </li> </ol> @@ -303,7 +318,7 @@ <div id="static"></div> <!-- API PAGE --> - <div class="apiPage" jsselect="apiDefinition"> + <div class="apiPage" jsselect="apiDefinition" jsvalues="$scope:''"> <a name="apiReference"></a> <h2 jscontent="'API reference: ' + getModuleName()">API reference: chrome.apiname </h2> @@ -326,19 +341,20 @@ </div> <!-- /apiGroup --> <!-- METHODS --> - <div jsdisplay="functions && functions.length > 0" class="apiGroup" id="methods"> - <a name="methods"></a> - <h3>Methods</h3> + <div id="methodsTemplate" class="apiGroup" + jsdisplay="$this.functions && $this.functions.length > 0"> + <a jsvalues=".name:getAnchorName('global', 'methods', $scope)"></a> + <h3 jscontent="$scope ? 'Methods of ' + $scope : 'Methods'">Methods</h3> <!-- iterates over all functions --> <div class="apiItem" jsselect="functions.sort(sortByName)" jsdisplay="!($this.nodoc)"> - <a jsvalues=".name:'method-' + name"></a> <!-- method-anchor --> + <a jsvalues=".name:getAnchorName('method', name, $scope)"></a> <!-- method-anchor --> <h4 jscontent="name">method name</h4> <div class="summary"><span jsdisplay="returns" jscontent="getTypeName(returns)">void</span> <!-- Note: intentionally longer 80 columns --> - <span jscontent="getFullyQualifiedFunctionName($this)">chrome.module.methodName</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''"><span jsdisplay="$index">, </span><span jscontent="getTypeName($this)"></span> + <span jscontent="getFullyQualifiedFunctionName($scope, $this)">chrome.module.methodName</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''"><span jsdisplay="$index">, </span><span jscontent="getTypeName($this)"></span> <var><span jscontent="$this.name"></span></var></span>)</div> <div class="description"> @@ -348,7 +364,7 @@ </p> <!-- PARAMETERS --> - <h4>Parameters</h4> + <h4 jsdisplay="$this.parameters && $this.parameters.length > 0">Parameters</h4> <dl> <div jsselect="parameters"> <div transclude="valueTemplate"> @@ -403,19 +419,19 @@ </div> <!-- /apiGroup --> <!-- EVENTS --> - <div jsdisplay="events && events.length > 0" class="apiGroup"> - <a name="events"></a> - <h3 id="events">Events</h3> - + <div id="eventsTemplate" class="apiGroup" + jsdisplay="$this.events && $this.events.length > 0"> + <a jsvalues=".name:getAnchorName('global', 'events', $scope)"></a> + <h3 jscontent="$scope ? 'Events of ' + $scope : 'Events'">Events</h3> <!-- iterates over all events --> - <div jsselect="events.sort(sortByName)" class="apiItem" + <div class="apiItem" jsselect="$this.events.sort(sortByName)" jsdisplay="!($this.nodoc)"> - <a jsvalues=".name:'event-' + name"></a> + <a jsvalues=".name:getAnchorName('event', name, $scope)"></a> <h4 jscontent="name">event name</h4> <div class="summary"> <!-- Note: intentionally longer 80 columns --> - <span jscontent="getModuleName() + '.'" class="subdued">chrome.bookmarks</span><span jscontent="name">onEvent</span><span class="subdued">.addListener</span>(function(<span jscontent="getSignatureString(parameters)">Type param1, Type param2</span>) <span class="subdued">{...}</span>); + <span jscontent="(getObjectName($scope) || getModuleName()) + '.'" class="subdued">chrome.bookmarks</span><span jscontent="name">onEvent</span><span class="subdued">.addListener</span>(function(<span jscontent="getSignatureString($this.parameters)">Type param1, Type param2</span>) <span class="subdued">{...}</span>); </div> <div class="description"> @@ -425,14 +441,15 @@ </p> <!-- PARAMETERS --> - <h4>Parameters</h4> - <dl> - <div jsselect="parameters"> - <div transclude="valueTemplate"> + <div jsdisplay="parameters && parameters.length > 0"> + <h4>Parameters</h4> + <dl> + <div jsselect="parameters"> + <div transclude="valueTemplate"> + </div> </div> - </div> - </dl> - + </dl> + </div> </div> <!-- /decription --> </div> <!-- /apiItem --> |