aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorClay Murphy <claym@google.com>2013-07-11 08:08:16 -0700
committerAndroid Git Automerger <android-git-automerger@android.com>2013-07-11 08:08:16 -0700
commit215885bd98b302da4c4c1c42f657e01051374bb3 (patch)
tree49c9c5594e16483a5253394fd1c949fb03e8d261
parent897ac47373f3a4561c6dccc8228972b8e3174906 (diff)
parent48f98c9ceba9c39945ab41460468c2901b8e4869 (diff)
downloadsource.android.com-215885bd98b302da4c4c1c42f657e01051374bb3.tar.gz
am 48f98c9c: am 945af1aa: Docs: Removing code formatting from headers Bug: 8905394
* commit '48f98c9ceba9c39945ab41460468c2901b8e4869': Docs: Removing code formatting from headers Bug: 8905394
-rw-r--r--src/devices/tech/dalvik/dex-format.jd174
1 files changed, 84 insertions, 90 deletions
diff --git a/src/devices/tech/dalvik/dex-format.jd b/src/devices/tech/dalvik/dex-format.jd
index fffc5464..e78d18b6 100644
--- a/src/devices/tech/dalvik/dex-format.jd
+++ b/src/devices/tech/dalvik/dex-format.jd
@@ -260,8 +260,8 @@ values are unlikely to be needed).</p>
<h2>Bitfield, String, and Constant Definitions</h2>
-<h3><code>DEX_FILE_MAGIC</code></h3>
-<h4>embedded in <code>header_item</code></h4>
+<h3>DEX_FILE_MAGIC</h3>
+<h4>embedded in header_item</h4>
<p>The constant array/string <code>DEX_FILE_MAGIC</code> is the list of
bytes that must appear at the beginning of a <code>.dex</code> file
@@ -286,8 +286,8 @@ platform (February&ndash;March 2008). In several respects, these earlier
versions of the format differ significantly from the version described in this
document.</p>
-<h3><code>ENDIAN_CONSTANT</code> and <code>REVERSE_ENDIAN_CONSTANT</code></h3>
-<h4>embedded in <code>header_item</code></h4>
+<h3>ENDIAN_CONSTANT and REVERSE_ENDIAN_CONSTANT</h3>
+<h4>embedded in header_item</h4>
<p>The constant <code>ENDIAN_CONSTANT</code> is used to indicate the
endianness of the file in which it is found. Although the standard
@@ -302,9 +302,8 @@ uint ENDIAN_CONSTANT = 0x12345678;
uint REVERSE_ENDIAN_CONSTANT = 0x78563412;
</pre>
-<h3><code>NO_INDEX</code></h3>
-<h4>embedded in <code>class_def_item</code> and
-<code>debug_info_item</code></h4>
+<h3>NO_INDEX</h3>
+<h4>embedded in class_def_item and debug_info_item</h4>
<p>The constant <code>NO_INDEX</code> is used to indicate that
an index value is absent.</p>
@@ -319,10 +318,9 @@ representable as a single byte in the <code>uleb128p1</code> encoding.</p>
uint NO_INDEX = 0xffffffff; // == -1 if treated as a signed int
</pre>
-<h3><code>access_flags</code> Definitions</h3>
-<h4>embedded in <code>class_def_item</code>,
-<code>encoded_field</code>, <code>encoded_method</code>, and
-<code>InnerClass</code></h4>
+<h3>access_flags Definitions</h3>
+<h4>embedded in class_def_item, encoded_field, encoded_method, and
+InnerClass</h4>
<p>Bitfields of these flags are used to indicate the accessibility and
overall properties of classes and class members.</p>
@@ -535,9 +533,8 @@ MUTF-8 is actually closer to the (relatively less well-known) encoding
<a href="http://www.unicode.org/reports/tr26/">CESU-8</a> than to UTF-8
per se.</p>
-<h3><code>encoded_value</code> Encoding</h3>
-<h4>embedded in <code>annotation_element</code> and
-<code>encoded_array_item</code></h4>
+<h3>encoded_value Encoding</h3>
+<h4>embedded in annotation_element and encoded_array_item </h4>
<p>An <code>encoded_value</code> is an encoded piece of (nearly)
arbitrary hierarchically structured data. The encoding is meant to
@@ -738,7 +735,7 @@ be both compact and straightforward to parse.</p>
</tbody>
</table>
-<h3><code>encoded_array</code> Format</h3>
+<h3>encoded_array Format</h3>
<table class="format">
<thead>
@@ -765,7 +762,7 @@ be both compact and straightforward to parse.</p>
</tbody>
</table>
-<h3><code>encoded_annotation</code> Format</h3>
+<h3>encoded_annotation Format</h3>
<table class="format">
<thead>
@@ -799,7 +796,7 @@ be both compact and straightforward to parse.</p>
</tbody>
</table>
-<h3><code>annotation_element</code> Format</h3>
+<h3>annotation_element Format</h3>
<table class="format">
<thead>
@@ -902,7 +899,7 @@ encoding.</p>
</table>
<h3><i>MemberName</i></h3>
-<h4>used by <code>field_id_item</code> and <code>method_id_item</code></h4>
+<h4>used by field_id_item and method_id_item</h4>
<p>A <i>MemberName</i> is the name of a member of a class, members being
fields, methods, and inner classes.</p>
@@ -939,7 +936,7 @@ optional package specifier followed by a required name.</p>
</table>
<h3><i>TypeDescriptor</i></h3>
-<h4>used by <code>type_id_item</code></h4>
+<h4>used by type_id_item</h4>
<p>A <i>TypeDescriptor</i> is the representation of any type, including
primitives, classes, arrays, and <code>void</code>. See below for
@@ -1009,7 +1006,7 @@ the meaning of the various versions.</p>
</table>
<h3><i>ShortyDescriptor</i></h3>
-<h4>used by <code>proto_id_item</code></h4>
+<h4>used by proto_id_item</h4>
<p>A <i>ShortyDescriptor</i> is the short form representation of a method
prototype, including return and parameter types, except that there is
@@ -1139,8 +1136,8 @@ all reference types are represented by a single <code>'L'</code> character.</p>
<p>This section includes definitions for each of the top-level items that
may appear in a <code>.dex</code> file.
-<h3><code>header_item</code></h3>
-<h4>appears in the <code>header</code> section</h4>
+<h3>header_item</h3>
+<h4>appears in the header section</h4>
<h4>alignment: 4 bytes</h4>
<table class="format">
@@ -1322,9 +1319,9 @@ may appear in a <code>.dex</code> file.
</tbody>
</table>
-<h3><code>map_list</code></h3>
-<h4>appears in the <code>data</code> section</h4>
-<h4>referenced from <code>header_item</code></h4>
+<h3>map_list</h3>
+<h4>appears in the data section</h4>
+<h4>referenced from header_item</h4>
<h4>alignment: 4 bytes</h4>
<p>This is a list of the entire contents of a file, in order. It
@@ -1359,7 +1356,7 @@ be ordered by initial offset and must not overlap.</p>
</tbody>
</table>
-<h3><code>map_item</code> Format</h3>
+<h3>map_item Format</h3>
<table class="format">
<thead>
@@ -1518,8 +1515,8 @@ be ordered by initial offset and must not overlap.</p>
</table>
-<h3><code>string_id_item</code></h3>
-<h4>appears in the <code>string_ids</code> section</h4>
+<h3>string_id_item</h3>
+<h4>appears in the string_ids section</h4>
<h4>alignment: 4 bytes</h4>
<table class="format">
@@ -1544,8 +1541,8 @@ be ordered by initial offset and must not overlap.</p>
</tbody>
</table>
-<h3><code>string_data_item</code></h3>
-<h4>appears in the <code>data</code> section</h4>
+<h3>string_data_item</h3>
+<h4>appears in the data section</h4>
<h4>alignment: none (byte-aligned)</h4>
<table class="format">
@@ -1583,8 +1580,8 @@ be ordered by initial offset and must not overlap.</p>
</tbody>
</table>
-<h3><code>type_id_item</code></h3>
-<h4>appears in the <code>type_ids</code> section</h4>
+<h3>type_id_item</h3>
+<h4>appears in the type_ids section</h4>
<h4>alignment: 4 bytes</h4>
<table class="format">
@@ -1607,8 +1604,8 @@ be ordered by initial offset and must not overlap.</p>
</tbody>
</table>
-<h3><code>proto_id_item</code></h3>
-<h4>appears in the <code>proto_ids</code> section</h4>
+<h3>proto_id_item</h3>
+<h4>appears in the proto_ids section</h4>
<h4>alignment: 4 bytes</h4>
<table class="format">
@@ -1650,8 +1647,8 @@ be ordered by initial offset and must not overlap.</p>
</tbody>
</table>
-<h3><code>field_id_item</code></h3>
-<h4>appears in the <code>field_ids</code> section</h4>
+<h3>field_id_item</h3>
+<h4>appears in the field_ids section</h4>
<h4>alignment: 4 bytes</h4>
<table class="format">
@@ -1688,8 +1685,8 @@ be ordered by initial offset and must not overlap.</p>
</tbody>
</table>
-<h3><code>method_id_item</code></h3>
-<h4>appears in the <code>method_ids</code> section</h4>
+<h3>method_id_item</h3>
+<h4>appears in the method_ids section</h4>
<h4>alignment: 4 bytes</h4>
<table class="format">
@@ -1726,8 +1723,8 @@ be ordered by initial offset and must not overlap.</p>
</tbody>
</table>
-<h3><code>class_def_item</code></h3>
-<h4>appears in the <code>class_defs</code> section</h4>
+<h3>class_def_item</h3>
+<h4>appears in the class_defs section</h4>
<h4>alignment: 4 bytes</h4>
<table class="format">
@@ -1830,9 +1827,9 @@ be ordered by initial offset and must not overlap.</p>
</tbody>
</table>
-<h3><code>class_data_item</code></h3>
-<h4>referenced from <code>class_def_item</code></h4>
-<h4>appears in the <code>data</code> section</h4>
+<h3>class_data_item</h3>
+<h4>referenced from class_def_item</h4>
+<h4>appears in the data section</h4>
<h4>alignment: none (byte-aligned)</h4>
<table class="format">
@@ -1905,7 +1902,7 @@ be ordered by initial offset and must not overlap.</p>
<p><b>Note:</b> All elements' <code>field_id</code>s and
<code>method_id</code>s must refer to the same defining class.</p>
-<h3><code>encoded_field</code> Format</h3>
+<h3>encoded_field Format</h3>
<table class="format">
<thead>
@@ -1935,7 +1932,7 @@ be ordered by initial offset and must not overlap.</p>
</tbody>
</table>
-<h3><code>encoded_method</code> Format</h3>
+<h3>encoded_method Format</h3>
<table class="format">
<thead>
@@ -1975,10 +1972,9 @@ be ordered by initial offset and must not overlap.</p>
</tbody>
</table>
-<h3><code>type_list</code></h3>
-<h4>referenced from <code>class_def_item</code> and
-<code>proto_id_item</code></h4>
-<h4>appears in the <code>data</code> section</h4>
+<h3>type_list</h3>
+<h4>referenced from class_def_item and proto_id_item</h4>
+<h4>appears in the data section</h4>
<h4>alignment: 4 bytes</h4>
<table class="format">
@@ -2003,7 +1999,7 @@ be ordered by initial offset and must not overlap.</p>
</tbody>
</table>
-<h3><code>type_item</code> Format</h3>
+<h3>type_item Format</h3>
<table class="format">
<thead>
@@ -2022,9 +2018,9 @@ be ordered by initial offset and must not overlap.</p>
</tbody>
</table>
-<h3><code>code_item</code></h3>
-<h4>referenced from <code>encoded_method</code></h4>
-<h4>appears in the <code>data</code> section</h4>
+<h3>code_item</h3>
+<h4>referenced from encoded_method</h4>
+<h4>appears in the data section</h4>
<h4>alignment: 4 bytes</h4>
<table class="format">
@@ -2119,7 +2115,7 @@ be ordered by initial offset and must not overlap.</p>
</tbody>
</table>
-<h3><code>try_item</code> Format </h3>
+<h3>try_item Format</h3>
<table class="format">
<thead>
@@ -2157,7 +2153,7 @@ be ordered by initial offset and must not overlap.</p>
</tbody>
</table>
-<h3><code>encoded_catch_handler_list</code> Format</h3>
+<h3>encoded_catch_handler_list Format</h3>
<table class="format">
<thead>
@@ -2182,7 +2178,7 @@ be ordered by initial offset and must not overlap.</p>
</tbody>
</table>
-<h3><code>encoded_catch_handler</code> Format</h3>
+<h3>encoded_catch_handler Format</h3>
<table class="format">
<thead>
@@ -2222,7 +2218,7 @@ be ordered by initial offset and must not overlap.</p>
</tbody>
</table>
-<h3><code>encoded_type_addr_pair</code> Format</h3>
+<h3>encoded_type_addr_pair Format</h3>
<table class="format">
<thead>
@@ -2248,9 +2244,9 @@ be ordered by initial offset and must not overlap.</p>
</tbody>
</table>
-<h3><code>debug_info_item</code></h3>
-<h4>referenced from <code>code_item</code></h4>
-<h4>appears in the <code>data</code> section</h4>
+<h3>debug_info_item</h3>
+<h4>referenced from code_item</h4>
+<h4>appears in the data section</h4>
<h4>alignment: none (byte-aligned)</h4>
<p>Each <code>debug_info_item</code> defines a DWARF3-inspired byte-coded
@@ -2481,9 +2477,9 @@ line += DBG_LINE_BASE + (adjusted_opcode % DBG_LINE_RANGE)
address += (adjusted_opcode / DBG_LINE_RANGE)
</pre>
-<h3><code>annotations_directory_item</code></h3>
-<h4>referenced from <code>class_def_item</code></h4>
-<h4>appears in the <code>data</code> section</h4>
+<h3>annotations_directory_item</h3>
+<h4>referenced from class_def_item</h4>
+<h4>appears in the data section</h4>
<h4>alignment: 4 bytes</h4>
<table class="format">
@@ -2547,7 +2543,7 @@ address += (adjusted_opcode / DBG_LINE_RANGE)
<p><b>Note:</b> All elements' <code>field_id</code>s and
<code>method_id</code>s must refer to the same defining class.</p>
-<h3><code>field_annotation</code> Format</h3>
+<h3>field_annotation Format</h3>
<table class="format">
<thead>
@@ -2577,7 +2573,7 @@ address += (adjusted_opcode / DBG_LINE_RANGE)
</tbody>
</table>
-<h3><code>method_annotation</code> Format</h3>
+<h3>method_annotation Format</h3>
<table class="format">
<thead>
@@ -2607,7 +2603,7 @@ address += (adjusted_opcode / DBG_LINE_RANGE)
</tbody>
</table>
-<h3><code>parameter_annotation</code> Format</h3>
+<h3>parameter_annotation Format</h3>
<table class="format">
<thead>
@@ -2637,9 +2633,9 @@ address += (adjusted_opcode / DBG_LINE_RANGE)
</tbody>
</table>
-<h3><code>annotation_set_ref_list</code></h3>
-<h4>referenced from <code>parameter_annotations_item</code></h4>
-<h4>appears in the <code>data</code> section</h4>
+<h3>annotation_set_ref_list</h3>
+<h4>referenced from parameter_annotations_item</h4>
+<h4>appears in the data section</h4>
<h4>alignment: 4 bytes</h4>
<table class="format">
@@ -2664,7 +2660,7 @@ address += (adjusted_opcode / DBG_LINE_RANGE)
</tbody>
</table>
-<h3><code>annotation_set_ref_item</code> Format</h3>
+<h3>annotation_set_ref_item Format</h3>
<table class="format">
<thead>
@@ -2688,12 +2684,10 @@ address += (adjusted_opcode / DBG_LINE_RANGE)
</tbody>
</table>
-<h3><code>annotation_set_item</code></h3>
-<h4>referenced from <code>annotations_directory_item</code>,
-<code>field_annotations_item</code>,
-<code>method_annotations_item</code>, and
-<code>annotation_set_ref_item</code></h4>
-<h4>appears in the <code>data</code> section</h4>
+<h3>annotation_set_item</h3>
+<h4>referenced from annotations_directory_item, field_annotations_item,
+method_annotations_item, and annotation_set_ref_item</h4>
+<h4>appears in the data section</h4>
<h4>alignment: 4 bytes</h4>
<table class="format">
@@ -2720,7 +2714,7 @@ address += (adjusted_opcode / DBG_LINE_RANGE)
</tbody>
</table>
-<h3><code>annotation_off_item</code> Format</h3>
+<h3>annotation_off_item Format</h3>
<table class="format">
<thead>
@@ -2744,9 +2738,9 @@ address += (adjusted_opcode / DBG_LINE_RANGE)
</table>
-<h3><code>annotation_item</code></h3>
-<h4>referenced from <code>annotation_set_item</code></h4>
-<h4>appears in the <code>data</code> section</h4>
+<h3>annotation_item</h3>
+<h4>referenced from annotation_set_item</h4>
+<h4>appears in the data section</h4>
<h4>alignment: none (byte-aligned)</h4>
<table class="format">
@@ -2810,9 +2804,9 @@ address += (adjusted_opcode / DBG_LINE_RANGE)
</tbody>
</table>
-<h3><code>encoded_array_item</code></h3>
-<h4>referenced from <code>class_def_item</code></h4>
-<h4>appears in the <code>data</code> section</h4>
+<h3>encoded_array_item</h3>
+<h4>referenced from class_def_item</h4>
+<h4>appears in the data section</h4>
<h4>alignment: none (byte-aligned)</h4>
<table class="format">
@@ -2844,7 +2838,7 @@ generally only accessed indirectly by client (non-system) code.</p>
<p>System annotations are represented in <code>.dex</code> files as
annotations with visibility set to <code>VISIBILITY_SYSTEM</code>.
-<h3><code>dalvik.annotation.AnnotationDefault</code></h3>
+<h3>dalvik.annotation.AnnotationDefault</h3>
<h4>appears on methods in annotation interfaces</h4>
<p>An <code>AnnotationDefault</code> annotation is attached to each
@@ -2870,7 +2864,7 @@ annotation interface which wishes to indicate default bindings.</p>
</tbody>
</table>
-<h3><code>dalvik.annotation.EnclosingClass</code></h3>
+<h3>dalvik.annotation.EnclosingClass</h3>
<h4>appears on classes</h4>
<p>An <code>EnclosingClass</code> annotation is attached to each class
@@ -2898,7 +2892,7 @@ both an <code>EnclosingClass</code> and an
</tbody>
</table>
-<h3><code>dalvik.annotation.EnclosingMethod</code></h3>
+<h3>dalvik.annotation.EnclosingMethod</h3>
<h4>appears on classes</h4>
<p>An <code>EnclosingMethod</code> annotation is attached to each class
@@ -2924,7 +2918,7 @@ and an <code>EnclosingMethod</code> annotation.</p>
</tbody>
</table>
-<h3><code>dalvik.annotation.InnerClass</code></h3>
+<h3>dalvik.annotation.InnerClass</h3>
<h4>appears on classes</h4>
<p>An <code>InnerClass</code> annotation is attached to each class
@@ -2961,7 +2955,7 @@ Any class which has this annotation must also have <i>either</i> an
</tbody>
</table>
-<h3><code>dalvik.annotation.MemberClasses</code></h3>
+<h3>dalvik.annotation.MemberClasses</h3>
<h4>appears on classes</h4>
<p>A <code>MemberClasses</code> annotation is attached to each class
@@ -2985,7 +2979,7 @@ that has a name.)</p>
</tbody>
</table>
-<h3><code>dalvik.annotation.Signature</code></h3>
+<h3>dalvik.annotation.Signature</h3>
<h4>appears on classes, fields, and methods</h4>
<p>A <code>Signature</code> annotation is attached to each class,
@@ -3028,7 +3022,7 @@ tools that generate <code>.dex</code> files.</p>
</tbody>
</table>
-<h3><code>dalvik.annotation.Throws</code></h3>
+<h3>dalvik.annotation.Throws</h3>
<h4>appears on methods</h4>
<p>A <code>Throws</code> annotation is attached to each method which is