OLD | NEW |
(Empty) | |
| 1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.or
g/TR/html4/loose.dtd"> |
| 2 <!-- NewPage --> |
| 3 <html lang="en"> |
| 4 <head> |
| 5 <title>API Help</title> |
| 6 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style"> |
| 7 </head> |
| 8 <body> |
| 9 <script type="text/javascript"><!-- |
| 10 if (location.href.indexOf('is-external=true') == -1) { |
| 11 parent.document.title="API Help"; |
| 12 } |
| 13 //--> |
| 14 </script> |
| 15 <noscript> |
| 16 <div>JavaScript is disabled on your browser.</div> |
| 17 </noscript> |
| 18 <!-- ========= START OF TOP NAVBAR ======= --> |
| 19 <div class="topNav"><a name="navbar_top"> |
| 20 <!-- --> |
| 21 </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar
_top_firstrow"> |
| 22 <!-- --> |
| 23 </a> |
| 24 <ul class="navList" title="Navigation"> |
| 25 <li><a href="org/libjpegturbo/turbojpeg/package-summary.html">Package</a></li> |
| 26 <li>Class</li> |
| 27 <li><a href="org/libjpegturbo/turbojpeg/package-tree.html">Tree</a></li> |
| 28 <li><a href="deprecated-list.html">Deprecated</a></li> |
| 29 <li><a href="index-all.html">Index</a></li> |
| 30 <li class="navBarCell1Rev">Help</li> |
| 31 </ul> |
| 32 </div> |
| 33 <div class="subNav"> |
| 34 <ul class="navList"> |
| 35 <li>Prev</li> |
| 36 <li>Next</li> |
| 37 </ul> |
| 38 <ul class="navList"> |
| 39 <li><a href="index.html?help-doc.html" target="_top">Frames</a></li> |
| 40 <li><a href="help-doc.html" target="_top">No Frames</a></li> |
| 41 </ul> |
| 42 <ul class="navList" id="allclasses_navbar_top"> |
| 43 <li><a href="allclasses-noframe.html">All Classes</a></li> |
| 44 </ul> |
| 45 <div> |
| 46 <script type="text/javascript"><!-- |
| 47 allClassesLink = document.getElementById("allclasses_navbar_top"); |
| 48 if(window==top) { |
| 49 allClassesLink.style.display = "block"; |
| 50 } |
| 51 else { |
| 52 allClassesLink.style.display = "none"; |
| 53 } |
| 54 //--> |
| 55 </script> |
| 56 </div> |
| 57 <a name="skip-navbar_top"> |
| 58 <!-- --> |
| 59 </a></div> |
| 60 <!-- ========= END OF TOP NAVBAR ========= --> |
| 61 <div class="header"> |
| 62 <h1 class="title">How This API Document Is Organized</h1> |
| 63 <div class="subTitle">This API (Application Programming Interface) document has
pages corresponding to the items in the navigation bar, described as follows.</d
iv> |
| 64 </div> |
| 65 <div class="contentContainer"> |
| 66 <ul class="blockList"> |
| 67 <li class="blockList"> |
| 68 <h2>Package</h2> |
| 69 <p>Each package has a page that contains a list of its classes and interfaces, w
ith a summary for each. This page can contain six categories:</p> |
| 70 <ul> |
| 71 <li>Interfaces (italic)</li> |
| 72 <li>Classes</li> |
| 73 <li>Enums</li> |
| 74 <li>Exceptions</li> |
| 75 <li>Errors</li> |
| 76 <li>Annotation Types</li> |
| 77 </ul> |
| 78 </li> |
| 79 <li class="blockList"> |
| 80 <h2>Class/Interface</h2> |
| 81 <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 de
scription, summary tables, and detailed member descriptions:</p> |
| 82 <ul> |
| 83 <li>Class inheritance diagram</li> |
| 84 <li>Direct Subclasses</li> |
| 85 <li>All Known Subinterfaces</li> |
| 86 <li>All Known Implementing Classes</li> |
| 87 <li>Class/interface declaration</li> |
| 88 <li>Class/interface description</li> |
| 89 </ul> |
| 90 <ul> |
| 91 <li>Nested Class Summary</li> |
| 92 <li>Field Summary</li> |
| 93 <li>Constructor Summary</li> |
| 94 <li>Method Summary</li> |
| 95 </ul> |
| 96 <ul> |
| 97 <li>Field Detail</li> |
| 98 <li>Constructor Detail</li> |
| 99 <li>Method Detail</li> |
| 100 </ul> |
| 101 <p>Each summary entry contains the first sentence from the detailed description
for that item. The summary entries are alphabetical, while the detailed descript
ions are in the order they appear in the source code. This preserves the logical
groupings established by the programmer.</p> |
| 102 </li> |
| 103 <li class="blockList"> |
| 104 <h2>Annotation Type</h2> |
| 105 <p>Each annotation type has its own separate page with the following sections:</
p> |
| 106 <ul> |
| 107 <li>Annotation Type declaration</li> |
| 108 <li>Annotation Type description</li> |
| 109 <li>Required Element Summary</li> |
| 110 <li>Optional Element Summary</li> |
| 111 <li>Element Detail</li> |
| 112 </ul> |
| 113 </li> |
| 114 <li class="blockList"> |
| 115 <h2>Enum</h2> |
| 116 <p>Each enum has its own separate page with the following sections:</p> |
| 117 <ul> |
| 118 <li>Enum declaration</li> |
| 119 <li>Enum description</li> |
| 120 <li>Enum Constant Summary</li> |
| 121 <li>Enum Constant Detail</li> |
| 122 </ul> |
| 123 </li> |
| 124 <li class="blockList"> |
| 125 <h2>Tree (Class Hierarchy)</h2> |
| 126 <p>There is a <a href="overview-tree.html">Class Hierarchy</a> page for all pack
ages, plus a hierarchy for each package. Each hierarchy page contains a list of
classes and a list of interfaces. The classes are organized by inheritance struc
ture starting with <code>java.lang.Object</code>. The interfaces do not inherit
from <code>java.lang.Object</code>.</p> |
| 127 <ul> |
| 128 <li>When viewing the Overview page, clicking on "Tree" displays the hierarchy fo
r all packages.</li> |
| 129 <li>When viewing a particular package, class or interface page, clicking "Tree"
displays the hierarchy for only that package.</li> |
| 130 </ul> |
| 131 </li> |
| 132 <li class="blockList"> |
| 133 <h2>Deprecated API</h2> |
| 134 <p>The <a href="deprecated-list.html">Deprecated API</a> page lists all of the A
PI that have been deprecated. A deprecated API is not recommended for use, gener
ally due to improvements, and a replacement API is usually given. Deprecated API
s may be removed in future implementations.</p> |
| 135 </li> |
| 136 <li class="blockList"> |
| 137 <h2>Index</h2> |
| 138 <p>The <a href="index-all.html">Index</a> contains an alphabetic list of all cla
sses, interfaces, constructors, methods, and fields.</p> |
| 139 </li> |
| 140 <li class="blockList"> |
| 141 <h2>Prev/Next</h2> |
| 142 <p>These links take you to the next or previous class, interface, package, or re
lated page.</p> |
| 143 </li> |
| 144 <li class="blockList"> |
| 145 <h2>Frames/No Frames</h2> |
| 146 <p>These links show and hide the HTML frames. All pages are available with or w
ithout frames.</p> |
| 147 </li> |
| 148 <li class="blockList"> |
| 149 <h2>All Classes</h2> |
| 150 <p>The <a href="allclasses-noframe.html">All Classes</a> link shows all classes
and interfaces except non-static nested types.</p> |
| 151 </li> |
| 152 <li class="blockList"> |
| 153 <h2>Serialized Form</h2> |
| 154 <p>Each serializable or externalizable class has a description of its serializat
ion 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 c
an get to this information by going to any serialized class and clicking "Serial
ized Form" in the "See also" section of the class description.</p> |
| 155 </li> |
| 156 <li class="blockList"> |
| 157 <h2>Constant Field Values</h2> |
| 158 <p>The <a href="constant-values.html">Constant Field Values</a> page lists the s
tatic final fields and their values.</p> |
| 159 </li> |
| 160 </ul> |
| 161 <em>This help file applies to API documentation generated using the standard doc
let.</em></div> |
| 162 <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| 163 <div class="bottomNav"><a name="navbar_bottom"> |
| 164 <!-- --> |
| 165 </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="nav
bar_bottom_firstrow"> |
| 166 <!-- --> |
| 167 </a> |
| 168 <ul class="navList" title="Navigation"> |
| 169 <li><a href="org/libjpegturbo/turbojpeg/package-summary.html">Package</a></li> |
| 170 <li>Class</li> |
| 171 <li><a href="org/libjpegturbo/turbojpeg/package-tree.html">Tree</a></li> |
| 172 <li><a href="deprecated-list.html">Deprecated</a></li> |
| 173 <li><a href="index-all.html">Index</a></li> |
| 174 <li class="navBarCell1Rev">Help</li> |
| 175 </ul> |
| 176 </div> |
| 177 <div class="subNav"> |
| 178 <ul class="navList"> |
| 179 <li>Prev</li> |
| 180 <li>Next</li> |
| 181 </ul> |
| 182 <ul class="navList"> |
| 183 <li><a href="index.html?help-doc.html" target="_top">Frames</a></li> |
| 184 <li><a href="help-doc.html" target="_top">No Frames</a></li> |
| 185 </ul> |
| 186 <ul class="navList" id="allclasses_navbar_bottom"> |
| 187 <li><a href="allclasses-noframe.html">All Classes</a></li> |
| 188 </ul> |
| 189 <div> |
| 190 <script type="text/javascript"><!-- |
| 191 allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| 192 if(window==top) { |
| 193 allClassesLink.style.display = "block"; |
| 194 } |
| 195 else { |
| 196 allClassesLink.style.display = "none"; |
| 197 } |
| 198 //--> |
| 199 </script> |
| 200 </div> |
| 201 <a name="skip-navbar_bottom"> |
| 202 <!-- --> |
| 203 </a></div> |
| 204 <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| 205 </body> |
| 206 </html> |
OLD | NEW |