OLD | NEW |
1 <div id="devModeWarning" class="displayModeWarning"> | 1 <div id="devModeWarning" class="displayModeWarning"> |
2 You are viewing extension docs in chrome via the 'file:' scheme: are you exp
ecting to see local changes when you refresh? You'll need run chrome with --allo
w-file-access-from-files. | 2 You are viewing extension docs in chrome via the 'file:' scheme: are you exp
ecting to see local changes when you refresh? You'll need run chrome with --allo
w-file-access-from-files. |
3 </div> | 3 </div> |
4 <div id="branchWarning" class="displayModeWarning"> | 4 <div id="branchWarning" class="displayModeWarning"> |
5 <span>WARNING: This is the <span id="branchName">BETA</span> documentation. | 5 <span>WARNING: This is the <span id="branchName">BETA</span> documentation. |
6 It may not work with the stable release of Chrome.</span> | 6 It may not work with the stable release of Chrome.</span> |
7 <select id='branchChooser'> | 7 <select id='branchChooser'> |
8 <option>Choose a different version... | 8 <option>Choose a different version... |
9 <option value="">Stable | 9 <option value="">Stable |
10 <option value="beta">Beta | 10 <option value="beta">Beta |
(...skipping 65 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
76 <dl> | 76 <dl> |
77 <div jsselect="getPropertyListFromObject($this)"> | 77 <div jsselect="getPropertyListFromObject($this)"> |
78 <div transclude="valueTemplate"> | 78 <div transclude="valueTemplate"> |
79 </div> | 79 </div> |
80 </div> | 80 </div> |
81 </dl> | 81 </dl> |
82 </dd> | 82 </dd> |
83 | 83 |
84 <!-- OBJECT METHODS --> | 84 <!-- OBJECT METHODS --> |
85 <dd jsdisplay="$this.type === 'object' && | 85 <dd jsdisplay="$this.type === 'object' && |
86 $this.functions && $this.functions.length > 0" | 86 filterDocumented($this.functions).length > 0" |
87 jsvalues="$scope:id"> | 87 jsvalues="$scope:id"> |
88 <div transclude="methodsTemplate"></div> | 88 <div transclude="methodsTemplate"></div> |
89 </dd> | 89 </dd> |
90 | 90 |
91 <!-- OBJECT EVENT FIELDS --> | 91 <!-- OBJECT EVENT FIELDS --> |
92 <dd jsdisplay="$this.type === 'object' && | 92 <dd jsdisplay="$this.type === 'object' && |
93 $this.events && $this.events.length > 0" | 93 filterDocumented($this.events).length > 0" |
94 jsvalues="$scope:id"> | 94 jsvalues="$scope:id"> |
95 <div transclude="eventsTemplate"></div> | 95 <div transclude="eventsTemplate"></div> |
96 </dd> | 96 </dd> |
97 | 97 |
98 <!-- FUNCTION PARAMETERS --> | 98 <!-- FUNCTION PARAMETERS --> |
99 <dd jsdisplay="isFunction($this) && $this.parameters && | 99 <dd jsdisplay="isFunction($this) && $this.parameters && |
100 $this.name != 'callback'"> | 100 $this.name != 'callback'"> |
101 <div transclude="functionParametersTemplate"></div> | 101 <div transclude="functionParametersTemplate"></div> |
102 </dd> | 102 </dd> |
103 | 103 |
(...skipping 14 matching lines...) Expand all Loading... |
118 <li id="propertiesTocTemplate" jsdisplay="$this.properties"> | 118 <li id="propertiesTocTemplate" jsdisplay="$this.properties"> |
119 <a href="#properties">Properties</a> | 119 <a href="#properties">Properties</a> |
120 <ol> | 120 <ol> |
121 <li jsselect="getPropertyListFromObject($this)"> | 121 <li jsselect="getPropertyListFromObject($this)"> |
122 <a jscontent="name" | 122 <a jscontent="name" |
123 jsvalues=".href:'#property-' + name" | 123 jsvalues=".href:'#property-' + name" |
124 href="#property-anchor">propertyName</a> | 124 href="#property-anchor">propertyName</a> |
125 </li> | 125 </li> |
126 </ol> | 126 </ol> |
127 </li> | 127 </li> |
128 <li id="methodsTocTemplate" jsdisplay="functions && functions.length >
0"> | 128 <li id="methodsTocTemplate" jsdisplay="filterDocumented(functions).len
gth > 0"> |
129 <a jsvalues=".href:'#' + getAnchorName('global', 'methods', $type)">
Methods</a> | 129 <a jsvalues=".href:'#' + getAnchorName('global', 'methods', $type)">
Methods</a> |
130 <ol> | 130 <ol> |
131 <li jsselect="functions.sort(sortByName)" | 131 <li jsselect="filterDocumented(functions).sort(sortByName)"> |
132 jsdisplay="!disableDocs($this)"> | |
133 <a jscontent="name" | 132 <a jscontent="name" |
134 jsvalues=".href:'#' + getAnchorName('method', name, $type)" | 133 jsvalues=".href:'#' + getAnchorName('method', name, $type)" |
135 href="#method-anchor">methodName</a> | 134 href="#method-anchor">methodName</a> |
136 </li> | 135 </li> |
137 </ol> | 136 </ol> |
138 </li> | 137 </li> |
139 <li id="eventsTocTemplate" jsdisplay="events && events.length > 0"> | 138 <li id="eventsTocTemplate" jsdisplay="filterDocumented(events).length
> 0"> |
140 <a jsvalues=".href:'#' + getAnchorName('global', 'events', $type)">E
vents</a> | 139 <a jsvalues=".href:'#' + getAnchorName('global', 'events', $type)">E
vents</a> |
141 <ol> | 140 <ol> |
142 <li jsselect="events.sort(sortByName)" | 141 <li jsselect="filterDocumented(events).sort(sortByName)"> |
143 jsdisplay="!disableDocs($this)"> | |
144 <a jscontent="name" | 142 <a jscontent="name" |
145 jsvalues=".href:'#' + getAnchorName('event', name, $type)" | 143 jsvalues=".href:'#' + getAnchorName('event', name, $type)" |
146 href="#event-anchor">eventName</a> | 144 href="#event-anchor">eventName</a> |
147 </li> | 145 </li> |
148 </ol> | 146 </ol> |
149 </li> | 147 </li> |
150 <li id="typesTocTemplate" jsdisplay="types && types.length > 0"> | 148 <li id="typesTocTemplate" jsdisplay="filterDocumented(types).length >
0"> |
151 <a href="#types">Types</a> | 149 <a href="#types">Types</a> |
152 <ol> | 150 <ol> |
153 <li jsselect="types.sort(sortByName)" | 151 <li jsselect="filterDocumented(types).sort(sortByName)"> |
154 jsdisplay="!($this.nodoc)"> | |
155 <a jscontent="id" | 152 <a jscontent="id" |
156 jsvalues=".href:'#type-' + id" | 153 jsvalues=".href:'#type-' + id" |
157 href="#id-anchor">id</a> | 154 href="#id-anchor">id</a> |
158 <ol jsvalues="$type:id"> | 155 <ol jsvalues="$type:id"> |
159 <div transclude="methodsTocTemplate"></div> | 156 <div transclude="methodsTocTemplate"></div> |
160 <div transclude="eventsTocTemplate"></div> | 157 <div transclude="eventsTocTemplate"></div> |
161 </ol> | 158 </ol> |
162 </li> | 159 </li> |
163 </ol> | 160 </ol> |
164 </li> | 161 </li> |
(...skipping 204 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
369 <span jscontent="getModuleName() + '.'">chrome.extension</span><
span jscontent="$this.name">lastError</span> | 366 <span jscontent="getModuleName() + '.'">chrome.extension</span><
span jscontent="$this.name">lastError</span> |
370 </div> | 367 </div> |
371 <div transclude="valueTemplate"> | 368 <div transclude="valueTemplate"> |
372 </div> | 369 </div> |
373 </div> | 370 </div> |
374 | 371 |
375 </div> <!-- /apiGroup --> | 372 </div> <!-- /apiGroup --> |
376 | 373 |
377 <!-- METHODS --> | 374 <!-- METHODS --> |
378 <div id="methodsTemplate" class="apiGroup" | 375 <div id="methodsTemplate" class="apiGroup" |
379 jsdisplay="$this.functions && $this.functions.length > 0"> | 376 jsdisplay="filterDocumented($this.functions).length > 0"> |
380 <a jsvalues=".name:getAnchorName('global', 'methods', $scope)"></a> | 377 <a jsvalues=".name:getAnchorName('global', 'methods', $scope)"></a> |
381 <h3 jscontent="$scope ? 'Methods of ' + $scope : 'Methods'">Methods<
/h3> | 378 <h3 jscontent="$scope ? 'Methods of ' + $scope : 'Methods'">Methods<
/h3> |
382 | 379 |
383 <!-- iterates over all functions --> | 380 <!-- iterates over all functions --> |
384 <div class="apiItem" jsselect="functions.sort(sortByName)" | 381 <div class="apiItem" jsselect="filterDocumented(functions).sort(sort
ByName)"> |
385 jsdisplay="!disableDocs($this)"> | |
386 <a jsvalues=".name:getAnchorName('method', name, $scope)"></a> <!-
- method-anchor --> | 382 <a jsvalues=".name:getAnchorName('method', name, $scope)"></a> <!-
- method-anchor --> |
387 <h4 jscontent="name">method name</h4> | 383 <h4 jscontent="name">method name</h4> |
388 | 384 |
389 <div class="summary"><span jsdisplay="returns" jscontent="getTypeN
ame(returns)">void</span> | 385 <div class="summary"><span jsdisplay="returns" jscontent="getTypeN
ame(returns)">void</span> |
390 <!-- Note: intentionally longer 80 columns --> | 386 <!-- Note: intentionally longer 80 columns --> |
391 <span jscontent="getFullyQualifiedFunctionName($scope, $this)"
>chrome.module.methodName</span>(<span jsselect="parameters" jsvalues="class:opt
ional ? 'optional' : ''"><span jsdisplay="$index">, </span><span jscontent="getT
ypeName($this)"></span> | 387 <span jscontent="getFullyQualifiedFunctionName($scope, $this)"
>chrome.module.methodName</span>(<span jsselect="parameters" jsvalues="class:opt
ional ? 'optional' : ''"><span jsdisplay="$index">, </span><span jscontent="getT
ypeName($this)"></span> |
392 <var><span jscontent="$this.name"></span></var></span>)</d
iv> | 388 <var><span jscontent="$this.name"></span></var></span>)</d
iv> |
393 | 389 |
394 <div class="description"> | 390 <div class="description"> |
395 <p class="todo" jsdisplay="!description">Undocumented.</p> | 391 <p class="todo" jsdisplay="!description">Undocumented.</p> |
(...skipping 51 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
447 can ensure that your extension won't be run in an earlier brow
ser version. | 443 can ensure that your extension won't be run in an earlier brow
ser version. |
448 </p> | 444 </p> |
449 </div> <!-- /description --> | 445 </div> <!-- /description --> |
450 | 446 |
451 </div> <!-- /apiItem --> | 447 </div> <!-- /apiItem --> |
452 | 448 |
453 </div> <!-- /apiGroup --> | 449 </div> <!-- /apiGroup --> |
454 | 450 |
455 <!-- EVENTS --> | 451 <!-- EVENTS --> |
456 <div id="eventsTemplate" class="apiGroup" | 452 <div id="eventsTemplate" class="apiGroup" |
457 jsdisplay="$this.events && $this.events.length > 0"> | 453 jsdisplay="filterDocumented($this.events).length > 0"> |
458 <a jsvalues=".name:getAnchorName('global', 'events', $scope)"></a> | 454 <a jsvalues=".name:getAnchorName('global', 'events', $scope)"></a> |
459 <h3 jscontent="$scope ? 'Events of ' + $scope : 'Events'">Events</h3
> | 455 <h3 jscontent="$scope ? 'Events of ' + $scope : 'Events'">Events</h3
> |
460 <!-- iterates over all events --> | 456 <!-- iterates over all events --> |
461 <div class="apiItem" jsselect="$this.events.sort(sortByName)" | 457 <div class="apiItem" jsselect="filterDocumented($this.events).sort(s
ortByName)"> |
462 jsdisplay="!disableDocs($this)"> | |
463 <a jsvalues=".name:getAnchorName('event', name, $scope)"></a> | 458 <a jsvalues=".name:getAnchorName('event', name, $scope)"></a> |
464 <h4 jscontent="name">event name</h4> | 459 <h4 jscontent="name">event name</h4> |
465 | 460 |
466 <div class="summary"> | 461 <div class="summary"> |
467 <!-- Note: intentionally longer 80 columns --> | 462 <!-- Note: intentionally longer 80 columns --> |
468 <span jscontent="(getObjectName($scope) || getModuleName()) + '.
'" class="subdued">chrome.bookmarks</span><span jscontent="name">onEvent</span><
span class="subdued">.addListener</span>(function(<span jscontent="getSignatureS
tring($this.parameters)">Type param1, Type param2</span>) <span class="subdued">
{...}</span><span jscontent="getOptionalSignatureSubstring($this.extraParameters
)">, Type opt_param1, Type opt_param2</span>); | 463 <span jscontent="(getObjectName($scope) || getModuleName()) + '.
'" class="subdued">chrome.bookmarks</span><span jscontent="name">onEvent</span><
span class="subdued">.addListener</span>(function(<span jscontent="getSignatureS
tring($this.parameters)">Type param1, Type param2</span>) <span class="subdued">
{...}</span><span jscontent="getOptionalSignatureSubstring($this.extraParameters
)">, Type opt_param1, Type opt_param2</span>); |
469 </div> | 464 </div> |
470 | 465 |
471 <div class="description"> | 466 <div class="description"> |
472 <p class="todo" jsdisplay="!description">Undocumented.</p> | 467 <p class="todo" jsdisplay="!description">Undocumented.</p> |
(...skipping 31 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
504 </div> | 499 </div> |
505 </div> | 500 </div> |
506 </dl> | 501 </dl> |
507 | 502 |
508 </div> <!-- /description --> | 503 </div> <!-- /description --> |
509 </div> <!-- /apiItem --> | 504 </div> <!-- /apiItem --> |
510 | 505 |
511 </div> <!-- /apiGroup --> | 506 </div> <!-- /apiGroup --> |
512 | 507 |
513 <!-- TYPES --> | 508 <!-- TYPES --> |
514 <div jsdisplay="types && types.length > 0" class="apiGroup"> | 509 <div jsdisplay="filterDocumented(types).length > 0" class="apiGroup"> |
515 <a name="types"></a> | 510 <a name="types"></a> |
516 <h3 id="types">Types</h3> | 511 <h3 id="types">Types</h3> |
517 | 512 |
518 <!-- iterates over all types --> | 513 <!-- iterates over all types --> |
519 <div jsselect="types.sort(sortByName)" jsdisplay="!($this.nodoc)" | 514 <div jsselect="filterDocumented(types).sort(sortByName)" class="apiI
tem"> |
520 class="apiItem"> | |
521 <a jsvalues=".name:'type-' + id"></a> | 515 <a jsvalues=".name:'type-' + id"></a> |
522 <h4 jscontent="id">type name</h4> | 516 <h4 jscontent="id">type name</h4> |
523 | 517 |
524 <div transclude="valueTemplate"> | 518 <div transclude="valueTemplate"> |
525 </div> | 519 </div> |
526 | 520 |
527 </div> <!-- /apiItem --> | 521 </div> <!-- /apiItem --> |
528 | 522 |
529 </div> <!-- /apiGroup --> | 523 </div> <!-- /apiGroup --> |
530 | 524 |
(...skipping 32 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
563 _uanchor=1; | 557 _uanchor=1; |
564 _uff=0; | 558 _uff=0; |
565 urchinTracker(); | 559 urchinTracker(); |
566 } | 560 } |
567 catch(e) {/* urchinTracker not available. */} | 561 catch(e) {/* urchinTracker not available. */} |
568 </script> | 562 </script> |
569 <!-- end analytics --> | 563 <!-- end analytics --> |
570 </div> | 564 </div> |
571 </div> <!-- /gc-footer --> | 565 </div> <!-- /gc-footer --> |
572 </div> <!-- /gc-container --> | 566 </div> <!-- /gc-container --> |
OLD | NEW |