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

Issues Search
    My Issues | Starred     Open | Closed | All

Side by Side Diff: chrome/common/extensions/docs/experimental.alarms.html

Issue 10082038: Hack together a quick doc generator for IDL files. (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src
Patch Set: separate alarms change Created 8 years, 8 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
« no previous file with comments | « chrome/common/extensions/docs/build/directory.py ('k') | chrome/common/extensions/docs/samples.json » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
1 <!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note: 1 <!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note:
2 1) The <head> information in this page is significant, should be uniform 2 1) The <head> information in this page is significant, should be uniform
3 across api docs and should be edited only with knowledge of the 3 across api docs and should be edited only with knowledge of the
4 templating mechanism. 4 templating mechanism.
5 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a 5 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a
6 browser, it will be re-generated from the template, json schema and 6 browser, it will be re-generated from the template, json schema and
7 authored overview content. 7 authored overview content.
8 4) The <body>.innerHTML is also generated by an offline step so that this 8 4) The <body>.innerHTML is also generated by an offline step so that this
9 page may easily be indexed by search engines. 9 page may easily be indexed by search engines.
10 --><html xmlns="http://www.w3.org/1999/xhtml"><head> 10 --><html xmlns="http://www.w3.org/1999/xhtml"><head>
(...skipping 207 matching lines...) Expand 10 before | Expand all | Expand 10 after
218 </li> 218 </li>
219 </ol> 219 </ol>
220 </li> 220 </li>
221 <li> 221 <li>
222 <a href="#types">Types</a> 222 <a href="#types">Types</a>
223 <ol> 223 <ol>
224 <li> 224 <li>
225 <a href="#type-Alarm">Alarm</a> 225 <a href="#type-Alarm">Alarm</a>
226 <ol> 226 <ol>
227 </ol> 227 </ol>
228 </li><li>
229 <a href="#type-AlarmCreateInfo">AlarmCreateInfo</a>
230 <ol>
231 </ol>
228 </li> 232 </li>
229 </ol> 233 </ol>
230 </li> 234 </li>
231 </ol> 235 </ol>
232 </li> 236 </li>
233 </ol> 237 </ol>
234 </div> 238 </div>
235 <!-- /TABLE OF CONTENTS --> 239 <!-- /TABLE OF CONTENTS -->
236 <!-- Standard content lead-in for experimental API pages --> 240 <!-- Standard content lead-in for experimental API pages -->
237 <p id="classSummary"> 241 <p id="classSummary">
(...skipping 72 matching lines...) Expand 10 before | Expand all | Expand 10 after
310 </dl> 314 </dl>
311 <!-- CALLBACK --> 315 <!-- CALLBACK -->
312 <!-- MIN_VERSION --> 316 <!-- MIN_VERSION -->
313 </div> <!-- /description --> 317 </div> <!-- /description -->
314 </div><div class="apiItem"> 318 </div><div class="apiItem">
315 <a name="method-create"></a> <!-- method-anchor --> 319 <a name="method-create"></a> <!-- method-anchor -->
316 <h4>create</h4> 320 <h4>create</h4>
317 <div class="summary"> 321 <div class="summary">
318 <!-- Note: intentionally longer 80 columns --> 322 <!-- Note: intentionally longer 80 columns -->
319 <span>chrome.experimental.alarms.create</span>(<span class="op tional"><span>string</span> 323 <span>chrome.experimental.alarms.create</span>(<span class="op tional"><span>string</span>
320 <var><span>name</span></var></span><span class="null"><spa n>, </span><span>object</span> 324 <var><span>name</span></var></span><span class="null"><spa n>, </span><span>AlarmCreateInfo</span>
321 <var><span>alarmInfo</span></var></span>)</div> 325 <var><span>alarmInfo</span></var></span>)</div>
322 <div class="description"> 326 <div class="description">
323 <p>Creates an alarm. After the delay is expired, the onAlarm eve nt is fired. If there is another alarm with the same name (or no name if none is specified), it will be cancelled and replaced by this alarm.</p> 327 <p>Creates an alarm. After the delay is expired, the onAlarm eve nt is fired. If there is another alarm with the same name (or no name if none is specified), it will be cancelled and replaced by this alarm.</p>
324 <!-- PARAMETERS --> 328 <!-- PARAMETERS -->
325 <h4>Parameters</h4> 329 <h4>Parameters</h4>
326 <dl> 330 <dl>
327 <div> 331 <div>
328 <div> 332 <div>
329 <dt> 333 <dt>
330 <var>name</var> 334 <var>name</var>
(...skipping 20 matching lines...) Expand all
351 </div><div> 355 </div><div>
352 <div> 356 <div>
353 <dt> 357 <dt>
354 <var>alarmInfo</var> 358 <var>alarmInfo</var>
355 <em> 359 <em>
356 <!-- TYPE --> 360 <!-- TYPE -->
357 <div style="display:inline"> 361 <div style="display:inline">
358 ( 362 (
359 <span id="typeTemplate"> 363 <span id="typeTemplate">
360 <span> 364 <span>
361 <span>object</span> 365 <a href="experimental.alarms.html#type-AlarmCreateInfo"> AlarmCreateInfo</a>
362 </span> 366 </span>
363 </span> 367 </span>
364 ) 368 )
365 </div> 369 </div>
366 </em> 370 </em>
367 </dt> 371 </dt>
368 <dd class="todo"> 372 <dd class="todo">
369 Undocumented. 373 Undocumented.
370 </dd> 374 </dd>
371 <!-- OBJECT PROPERTIES --> 375 <!-- OBJECT PROPERTIES -->
372 <dd>
373 <dl>
374 <div>
375 <div>
376 <dt>
377 <var>delayInSeconds</var>
378 <em>
379 <!-- TYPE -->
380 <div style="display:inline">
381 (
382 <span id="typeTemplate">
383 <span>
384 <span>integer</span>
385 </span>
386 </span>
387 )
388 </div>
389 </em>
390 </dt>
391 <dd>Length of time in seconds after which the onAlarm event should fir e. Note that granularity is not guaranteed: this value is more of a hint to the browser. For performance reasons, alarms may be delayed an arbitrary amount of t ime before firing.</dd>
392 <!-- OBJECT PROPERTIES -->
393 <!-- OBJECT METHODS --> 376 <!-- OBJECT METHODS -->
394 <!-- OBJECT EVENT FIELDS --> 377 <!-- OBJECT EVENT FIELDS -->
395 <!-- FUNCTION PARAMETERS --> 378 <!-- FUNCTION PARAMETERS -->
396 </div>
397 </div><div>
398 <div>
399 <dt>
400 <var>repeating</var>
401 <em>
402 <!-- TYPE -->
403 <div style="display:inline">
404 (
405 <span class="optional">optional</span>
406 <span id="typeTemplate">
407 <span>
408 <span>boolean</span>
409 </span>
410 </span>
411 )
412 </div>
413 </em>
414 </dt>
415 <dd>True if the alarm should repeatedly fire at regular intervals. Def aults to false.</dd>
416 <!-- OBJECT PROPERTIES -->
417 <!-- OBJECT METHODS -->
418 <!-- OBJECT EVENT FIELDS -->
419 <!-- FUNCTION PARAMETERS -->
420 </div>
421 </div>
422 </dl>
423 </dd>
424 <!-- OBJECT METHODS -->
425 <!-- OBJECT EVENT FIELDS -->
426 <!-- FUNCTION PARAMETERS -->
427 </div> 379 </div>
428 </div> 380 </div>
429 </dl> 381 </dl>
430 <!-- RETURNS --> 382 <!-- RETURNS -->
431 <dl> 383 <dl>
432 </dl> 384 </dl>
433 <!-- CALLBACK --> 385 <!-- CALLBACK -->
434 <!-- MIN_VERSION --> 386 <!-- MIN_VERSION -->
435 </div> <!-- /description --> 387 </div> <!-- /description -->
436 </div><div class="apiItem"> 388 </div><div class="apiItem">
437 <a name="method-get"></a> <!-- method-anchor --> 389 <a name="method-get"></a> <!-- method-anchor -->
438 <h4>get</h4> 390 <h4>get</h4>
439 <div class="summary"> 391 <div class="summary">
440 <!-- Note: intentionally longer 80 columns --> 392 <!-- Note: intentionally longer 80 columns -->
441 <span>chrome.experimental.alarms.get</span>(<span class="optio nal"><span>string</span> 393 <span>chrome.experimental.alarms.get</span>(<span class="optio nal"><span>string</span>
442 <var><span>name</span></var></span><span class="null"><spa n>, </span><span>function</span> 394 <var><span>name</span></var></span><span class="null"><spa n>, </span><span>function</span>
443 <var><span>callback</span></var></span>)</div> 395 <var><span>AlarmCallback</span></var></span>)</div>
444 <div class="description"> 396 <div class="description">
445 <p>Retrieves details about the specified alarm.</p> 397 <p>Retrieves details about the specified alarm.</p>
446 <!-- PARAMETERS --> 398 <!-- PARAMETERS -->
447 <h4>Parameters</h4> 399 <h4>Parameters</h4>
448 <dl> 400 <dl>
449 <div> 401 <div>
450 <div> 402 <div>
451 <dt> 403 <dt>
452 <var>name</var> 404 <var>name</var>
453 <em> 405 <em>
(...skipping 12 matching lines...) Expand all
466 </dt> 418 </dt>
467 <dd>The name of the alarm to get. Defaults to the empty string.</dd> 419 <dd>The name of the alarm to get. Defaults to the empty string.</dd>
468 <!-- OBJECT PROPERTIES --> 420 <!-- OBJECT PROPERTIES -->
469 <!-- OBJECT METHODS --> 421 <!-- OBJECT METHODS -->
470 <!-- OBJECT EVENT FIELDS --> 422 <!-- OBJECT EVENT FIELDS -->
471 <!-- FUNCTION PARAMETERS --> 423 <!-- FUNCTION PARAMETERS -->
472 </div> 424 </div>
473 </div><div> 425 </div><div>
474 <div> 426 <div>
475 <dt> 427 <dt>
476 <var>callback</var> 428 <var>AlarmCallback</var>
477 <em> 429 <em>
478 <!-- TYPE --> 430 <!-- TYPE -->
479 <div style="display:inline"> 431 <div style="display:inline">
480 ( 432 (
481 <span id="typeTemplate"> 433 <span id="typeTemplate">
482 <span> 434 <span>
483 <span>function</span> 435 <span>function</span>
484 </span> 436 </span>
485 </span> 437 </span>
486 ) 438 )
487 </div> 439 </div>
488 </em> 440 </em>
489 </dt> 441 </dt>
490 <dd class="todo"> 442 <dd class="todo">
491 Undocumented. 443 Undocumented.
492 </dd> 444 </dd>
493 <!-- OBJECT PROPERTIES --> 445 <!-- OBJECT PROPERTIES -->
494 <!-- OBJECT METHODS --> 446 <!-- OBJECT METHODS -->
495 <!-- OBJECT EVENT FIELDS --> 447 <!-- OBJECT EVENT FIELDS -->
496 <!-- FUNCTION PARAMETERS --> 448 <!-- FUNCTION PARAMETERS -->
449 <dd>
450 <div>
451 <h5>Parameters</h5>
452 <dl>
453 <div>
454 <div>
455 <dt>
456 <var>alarm</var>
457 <em>
458 <!-- TYPE -->
459 <div style="display:inline">
460 (
461 <span id="typeTemplate">
462 <span>
463 <a href="experimental.alarms.html#type-Alarm">Alarm</a>
464 </span>
465 </span>
466 )
467 </div>
468 </em>
469 </dt>
470 <dd class="todo">
471 Undocumented.
472 </dd>
473 <!-- OBJECT PROPERTIES -->
474 <!-- OBJECT METHODS -->
475 <!-- OBJECT EVENT FIELDS -->
476 <!-- FUNCTION PARAMETERS -->
497 </div> 477 </div>
478 </div>
479 </dl>
480 </div>
481 </dd>
482 </div>
498 </div> 483 </div>
499 </dl> 484 </dl>
500 <!-- RETURNS --> 485 <!-- RETURNS -->
501 <dl> 486 <dl>
502 </dl> 487 </dl>
503 <!-- CALLBACK --> 488 <!-- CALLBACK -->
504 <div> 489 <div>
505 <div> 490 <div>
506 <h4>Callback function</h4> 491 <h4>Callback function</h4>
507 <p> 492 <p>
(...skipping 33 matching lines...) Expand 10 before | Expand all | Expand 10 after
541 </div> 526 </div>
542 </div> 527 </div>
543 <!-- MIN_VERSION --> 528 <!-- MIN_VERSION -->
544 </div> <!-- /description --> 529 </div> <!-- /description -->
545 </div><div class="apiItem"> 530 </div><div class="apiItem">
546 <a name="method-getAll"></a> <!-- method-anchor --> 531 <a name="method-getAll"></a> <!-- method-anchor -->
547 <h4>getAll</h4> 532 <h4>getAll</h4>
548 <div class="summary"> 533 <div class="summary">
549 <!-- Note: intentionally longer 80 columns --> 534 <!-- Note: intentionally longer 80 columns -->
550 <span>chrome.experimental.alarms.getAll</span>(<span class="nu ll"><span>function</span> 535 <span>chrome.experimental.alarms.getAll</span>(<span class="nu ll"><span>function</span>
551 <var><span>callback</span></var></span>)</div> 536 <var><span>AlarmListCallback</span></var></span>)</div>
552 <div class="description"> 537 <div class="description">
553 <p>Gets an array of all the alarms.</p> 538 <p>Gets an array of all the alarms.</p>
554 <!-- PARAMETERS --> 539 <!-- PARAMETERS -->
555 <h4>Parameters</h4> 540 <h4>Parameters</h4>
556 <dl> 541 <dl>
557 <div> 542 <div>
558 <div> 543 <div>
559 <dt> 544 <dt>
560 <var>callback</var> 545 <var>AlarmListCallback</var>
561 <em> 546 <em>
562 <!-- TYPE --> 547 <!-- TYPE -->
563 <div style="display:inline"> 548 <div style="display:inline">
564 ( 549 (
565 <span id="typeTemplate"> 550 <span id="typeTemplate">
566 <span> 551 <span>
567 <span>function</span> 552 <span>function</span>
568 </span> 553 </span>
569 </span> 554 </span>
570 ) 555 )
571 </div> 556 </div>
572 </em> 557 </em>
573 </dt> 558 </dt>
574 <dd class="todo"> 559 <dd class="todo">
575 Undocumented. 560 Undocumented.
576 </dd> 561 </dd>
577 <!-- OBJECT PROPERTIES --> 562 <!-- OBJECT PROPERTIES -->
578 <!-- OBJECT METHODS --> 563 <!-- OBJECT METHODS -->
579 <!-- OBJECT EVENT FIELDS --> 564 <!-- OBJECT EVENT FIELDS -->
580 <!-- FUNCTION PARAMETERS --> 565 <!-- FUNCTION PARAMETERS -->
566 <dd>
567 <div>
568 <h5>Parameters</h5>
569 <dl>
570 <div>
571 <div>
572 <dt>
573 <var>alarms</var>
574 <em>
575 <!-- TYPE -->
576 <div style="display:inline">
577 (
578 <span id="typeTemplate">
579 <span>
580 <span>
581 array of <span><span>
582 <span>
583 <a href="experimental.alarms.html#type-Alarm">Alarm</a>
584 </span>
585 </span></span>
586 </span>
587 </span>
588 </span>
589 )
590 </div>
591 </em>
592 </dt>
593 <dd class="todo">
594 Undocumented.
595 </dd>
596 <!-- OBJECT PROPERTIES -->
597 <!-- OBJECT METHODS -->
598 <!-- OBJECT EVENT FIELDS -->
599 <!-- FUNCTION PARAMETERS -->
581 </div> 600 </div>
601 </div>
602 </dl>
603 </div>
604 </dd>
605 </div>
582 </div> 606 </div>
583 </dl> 607 </dl>
584 <!-- RETURNS --> 608 <!-- RETURNS -->
585 <dl> 609 <dl>
586 </dl> 610 </dl>
587 <!-- CALLBACK --> 611 <!-- CALLBACK -->
588 <div> 612 <div>
589 <div> 613 <div>
590 <h4>Callback function</h4> 614 <h4>Callback function</h4>
591 <p> 615 <p>
(...skipping 119 matching lines...) Expand 10 before | Expand all | Expand 10 after
711 </dt> 735 </dt>
712 <dd class="todo"> 736 <dd class="todo">
713 Undocumented. 737 Undocumented.
714 </dd> 738 </dd>
715 <!-- OBJECT PROPERTIES --> 739 <!-- OBJECT PROPERTIES -->
716 <dd> 740 <dd>
717 <dl> 741 <dl>
718 <div> 742 <div>
719 <div> 743 <div>
720 <dt> 744 <dt>
745 <var>delayInSeconds</var>
746 <em>
747 <!-- TYPE -->
748 <div style="display:inline">
749 (
750 <span id="typeTemplate">
751 <span>
752 <span>integer</span>
753 </span>
754 </span>
755 )
756 </div>
757 </em>
758 </dt>
759 <dd>Original length of time in seconds after which the onAlarm event s hould fire. TODO: need minimum=0</dd>
760 <!-- OBJECT PROPERTIES -->
761 <!-- OBJECT METHODS -->
762 <!-- OBJECT EVENT FIELDS -->
763 <!-- FUNCTION PARAMETERS -->
764 </div>
765 </div><div>
766 <div>
767 <dt>
721 <var>name</var> 768 <var>name</var>
722 <em> 769 <em>
723 <!-- TYPE --> 770 <!-- TYPE -->
724 <div style="display:inline"> 771 <div style="display:inline">
725 ( 772 (
726 <span id="typeTemplate"> 773 <span id="typeTemplate">
727 <span> 774 <span>
728 <span>string</span> 775 <span>string</span>
729 </span> 776 </span>
730 </span> 777 </span>
731 ) 778 )
732 </div> 779 </div>
733 </em> 780 </em>
734 </dt> 781 </dt>
735 <dd>Name of this alarm.</dd> 782 <dd>Name of this alarm.</dd>
736 <!-- OBJECT PROPERTIES --> 783 <!-- OBJECT PROPERTIES -->
737 <!-- OBJECT METHODS --> 784 <!-- OBJECT METHODS -->
738 <!-- OBJECT EVENT FIELDS --> 785 <!-- OBJECT EVENT FIELDS -->
739 <!-- FUNCTION PARAMETERS --> 786 <!-- FUNCTION PARAMETERS -->
740 </div> 787 </div>
741 </div><div> 788 </div><div>
742 <div> 789 <div>
743 <dt> 790 <dt>
791 <var>repeating</var>
792 <em>
793 <!-- TYPE -->
794 <div style="display:inline">
795 (
796 <span id="typeTemplate">
797 <span>
798 <span>boolean</span>
799 </span>
800 </span>
801 )
802 </div>
803 </em>
804 </dt>
805 <dd>True if the alarm repeatedly fires at regular intervals, false if it only fires once.</dd>
806 <!-- OBJECT PROPERTIES -->
807 <!-- OBJECT METHODS -->
808 <!-- OBJECT EVENT FIELDS -->
809 <!-- FUNCTION PARAMETERS -->
810 </div>
811 </div>
812 </dl>
813 </dd>
814 <!-- OBJECT METHODS -->
815 <!-- OBJECT EVENT FIELDS -->
816 <!-- FUNCTION PARAMETERS -->
817 </div>
818 </div><div class="apiItem">
819 <a name="type-AlarmCreateInfo"></a>
820 <h4>AlarmCreateInfo</h4>
821 <div>
822 <dt>
823 <em>
824 <!-- TYPE -->
825 <div style="display:inline">
826 (
827 <span id="typeTemplate">
828 <span>
829 <span>object</span>
830 </span>
831 </span>
832 )
833 </div>
834 </em>
835 </dt>
836 <dd class="todo">
837 Undocumented.
838 </dd>
839 <!-- OBJECT PROPERTIES -->
840 <dd>
841 <dl>
842 <div>
843 <div>
844 <dt>
744 <var>delayInSeconds</var> 845 <var>delayInSeconds</var>
745 <em> 846 <em>
746 <!-- TYPE --> 847 <!-- TYPE -->
747 <div style="display:inline"> 848 <div style="display:inline">
748 ( 849 (
749 <span id="typeTemplate"> 850 <span id="typeTemplate">
750 <span> 851 <span>
751 <span>integer</span> 852 <span>integer</span>
752 </span> 853 </span>
753 </span> 854 </span>
754 ) 855 )
755 </div> 856 </div>
756 </em> 857 </em>
757 </dt> 858 </dt>
758 <dd>Original length of time in seconds after which the onAlarm event s hould fire.</dd> 859 <dd>Length of time in seconds after which the onAlarm event should fir e. Note that granularity is not guaranteed: this value is more of a hint to the browser. For performance reasons, alarms may be delayed an arbitrary amount of t ime before firing. TODO: need minimum=0</dd>
759 <!-- OBJECT PROPERTIES --> 860 <!-- OBJECT PROPERTIES -->
760 <!-- OBJECT METHODS --> 861 <!-- OBJECT METHODS -->
761 <!-- OBJECT EVENT FIELDS --> 862 <!-- OBJECT EVENT FIELDS -->
762 <!-- FUNCTION PARAMETERS --> 863 <!-- FUNCTION PARAMETERS -->
763 </div> 864 </div>
764 </div><div> 865 </div><div>
765 <div> 866 <div>
766 <dt> 867 <dt>
767 <var>repeating</var> 868 <var>repeating</var>
768 <em> 869 <em>
769 <!-- TYPE --> 870 <!-- TYPE -->
770 <div style="display:inline"> 871 <div style="display:inline">
771 ( 872 (
873 <span class="optional">optional</span>
772 <span id="typeTemplate"> 874 <span id="typeTemplate">
773 <span> 875 <span>
774 <span>boolean</span> 876 <span>boolean</span>
775 </span> 877 </span>
776 </span> 878 </span>
777 ) 879 )
778 </div> 880 </div>
779 </em> 881 </em>
780 </dt> 882 </dt>
781 <dd>True if the alarm repeatedly fires at regular intervals, false if it only fires once.</dd> 883 <dd>True if the alarm should repeatedly fire at regular intervals. Def aults to false.</dd>
782 <!-- OBJECT PROPERTIES --> 884 <!-- OBJECT PROPERTIES -->
783 <!-- OBJECT METHODS --> 885 <!-- OBJECT METHODS -->
784 <!-- OBJECT EVENT FIELDS --> 886 <!-- OBJECT EVENT FIELDS -->
785 <!-- FUNCTION PARAMETERS --> 887 <!-- FUNCTION PARAMETERS -->
786 </div> 888 </div>
787 </div> 889 </div>
788 </dl> 890 </dl>
789 </dd> 891 </dd>
790 <!-- OBJECT METHODS --> 892 <!-- OBJECT METHODS -->
791 <!-- OBJECT EVENT FIELDS --> 893 <!-- OBJECT EVENT FIELDS -->
(...skipping 32 matching lines...) Expand 10 before | Expand all | Expand 10 after
824 _uff=0; 926 _uff=0;
825 urchinTracker(); 927 urchinTracker();
826 } 928 }
827 catch(e) {/* urchinTracker not available. */} 929 catch(e) {/* urchinTracker not available. */}
828 </script> 930 </script>
829 <!-- end analytics --> 931 <!-- end analytics -->
830 </div> 932 </div>
831 </div> <!-- /gc-footer --> 933 </div> <!-- /gc-footer -->
832 </div> <!-- /gc-container --> 934 </div> <!-- /gc-container -->
833 </body></html> 935 </body></html>
OLDNEW
« no previous file with comments | « chrome/common/extensions/docs/build/directory.py ('k') | chrome/common/extensions/docs/samples.json » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698