doc/org.eclipse.tracecompass.doc.user/reference/api/help-doc.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
   2 <!-- NewPage -->
   3 <html lang="en">
   4 <head>
   5 <!-- Generated by javadoc (version 1.7.0_51) on Sat Feb 22 08:24:16 EST 2014 -->
   6 <title>API Help</title>
   7 <meta name="date" content="2014-02-22">
   8 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
   9 </head>
  10 <body>
  11 <script type="text/javascript"><!--
  12     if (location.href.indexOf('is-external=true') == -1) {
  13         parent.document.title="API Help";
  14     }
  15 //-->
  16 </script>
  17 <noscript>
  18 <div>JavaScript is disabled on your browser.</div>
  19 </noscript>
  20 <div class="header">
  21 <h1 class="title">How This API Document Is Organized</h1>
  22 <div class="subTitle">This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.</div>
  23 </div>
  24 <div class="contentContainer">
  25 <ul class="blockList">
  26 <li class="blockList">
  27 <h2>Package</h2>
  28 <p>Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain six categories:</p>
  29 <ul>
  30 <li>Interfaces (italic)</li>
  31 <li>Classes</li>
  32 <li>Enums</li>
  33 <li>Exceptions</li>
  34 <li>Errors</li>
  35 <li>Annotation Types</li>
  36 </ul>
  37 </li>
  38 <li class="blockList">
  39 <h2>Class/Interface</h2>
  40 <p>Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:</p>
  41 <ul>
  42 <li>Class inheritance diagram</li>
  43 <li>Direct Subclasses</li>
  44 <li>All Known Subinterfaces</li>
  45 <li>All Known Implementing Classes</li>
  46 <li>Class/interface declaration</li>
  47 <li>Class/interface description</li>
  48 </ul>
  49 <ul>
  50 <li>Nested Class Summary</li>
  51 <li>Field Summary</li>
  52 <li>Constructor Summary</li>
  53 <li>Method Summary</li>
  54 </ul>
  55 <ul>
  56 <li>Field Detail</li>
  57 <li>Constructor Detail</li>
  58 <li>Method Detail</li>
  59 </ul>
  60 <p>Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.</p>
  61 </li>
  62 <li class="blockList">
  63 <h2>Annotation Type</h2>
  64 <p>Each annotation type has its own separate page with the following sections:</p>
  65 <ul>
  66 <li>Annotation Type declaration</li>
  67 <li>Annotation Type description</li>
  68 <li>Required Element Summary</li>
  69 <li>Optional Element Summary</li>
  70 <li>Element Detail</li>
  71 </ul>
  72 </li>
  73 <li class="blockList">
  74 <h2>Enum</h2>
  75 <p>Each enum has its own separate page with the following sections:</p>
  76 <ul>
  77 <li>Enum declaration</li>
  78 <li>Enum description</li>
  79 <li>Enum Constant Summary</li>
  80 <li>Enum Constant Detail</li>
  81 </ul>
  82 </li>
  83 <li class="blockList">
  84 <h2>Deprecated API</h2>
  85 <p>The <a href="deprecated-list.html">Deprecated API</a> page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.</p>
  86 </li>
  87 <li class="blockList">
  88 <h2>Prev/Next</h2>
  89 <p>These links take you to the next or previous class, interface, package, or related page.</p>
  90 </li>
  91 <li class="blockList">
  92 <h2>Frames/No Frames</h2>
  93 <p>These links show and hide the HTML frames.  All pages are available with or without frames.</p>
  94 </li>
  95 <li class="blockList">
  96 <h2>All Classes</h2>
  97 <p>The <a href="allclasses-noframe.html">All Classes</a> link shows all classes and interfaces except non-static nested types.</p>
  98 </li>
  99 <li class="blockList">
 100 <h2>Serialized Form</h2>
 101 <p>Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description.</p>
 102 </li>
 103 <li class="blockList">
 104 <h2>Constant Field Values</h2>
 105 <p>The <a href="constant-values.html">Constant Field Values</a> page lists the static final fields and their values.</p>
 106 </li>
 107 </ul>
 108 <em>This help file applies to API documentation generated using the standard doclet.</em></div>
 109 </body>
 110 </html>