Skip to content

Document ByteBuffer primitive reads #566

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jonathanpeppers merged 1 commit into from
Aug 16, 2026
Merged

Document ByteBuffer primitive reads #566

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 36 additions & 6 deletions docs/xml/Java.Nio/ByteBuffer.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -908,8 +908,13 @@
</ReturnValue>
<Docs>
<summary>Returns the char at the current position and increases the position by 2.</summary>
<value>To be added.</value>
<value>The char value at this buffer's current position.</value>
<remarks>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/java/nio/ByteBuffer#getChar()" title="Reference documentation">Java documentation for <code>java.nio.ByteBuffer.getChar()</code>.</a>
</format>
</para>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
<since version="Added in API level 1" />
Expand Down Expand Up @@ -1066,8 +1071,13 @@
<Docs>
<summary>Returns the double at the current position and increases the position by
8.</summary>
<value>To be added.</value>
<value>The double value at this buffer's current position.</value>
<remarks>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/java/nio/ByteBuffer#getDouble()" title="Reference documentation">Java documentation for <code>java.nio.ByteBuffer.getDouble()</code>.</a>
</format>
</para>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
<since version="Added in API level 1" />
Expand Down Expand Up @@ -1153,8 +1163,13 @@
<Docs>
<summary>Returns the float at the current position and increases the position by
4.</summary>
<value>To be added.</value>
<value>The float value at this buffer's current position.</value>
<remarks>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/java/nio/ByteBuffer#getFloat()" title="Reference documentation">Java documentation for <code>java.nio.ByteBuffer.getFloat()</code>.</a>
</format>
</para>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
<since version="Added in API level 1" />
Expand Down Expand Up @@ -1834,8 +1849,13 @@
</ReturnValue>
<Docs>
<summary>Returns the int at the current position and increases the position by 4.</summary>
<value>To be added.</value>
<value>The int value at this buffer's current position.</value>
<remarks>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/java/nio/ByteBuffer#getInt()" title="Reference documentation">Java documentation for <code>java.nio.ByteBuffer.getInt()</code>.</a>
</format>
</para>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
<since version="Added in API level 1" />
Expand Down Expand Up @@ -1926,8 +1946,13 @@
</ReturnValue>
<Docs>
<summary>Returns the long at the current position and increases the position by 8.</summary>
<value>To be added.</value>
<value>The long value at this buffer's current position.</value>
<remarks>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/java/nio/ByteBuffer#getLong()" title="Reference documentation">Java documentation for <code>java.nio.ByteBuffer.getLong()</code>.</a>
</format>
</para>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
<since version="Added in API level 1" />
Expand Down Expand Up @@ -3188,8 +3213,13 @@
</ReturnValue>
<Docs>
<summary>Returns the short at the current position and increases the position by 2.</summary>
<value>To be added.</value>
<value>The short value at this buffer's current position.</value>
<remarks>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/java/nio/ByteBuffer#getShort()" title="Reference documentation">Java documentation for <code>java.nio.ByteBuffer.getShort()</code>.</a>
</format>
</para>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
<since version="Added in API level 1" />
Expand Down