Skip to content

Document Android.Systems StructTimeval conversions #563

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 2 commits into from
Aug 16, 2026
+24 −9
Merged

Document Android.Systems StructTimeval conversions #563

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
54b7d87
Document StructTimeval conversions
jonathanpeppers Aug 15, 2026
77cab11
Clarify StructTimeval millisecond conversion
jonathanpeppers Aug 15, 2026
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
33 changes: 24 additions & 9 deletions docs/xml/Android.Systems/StructTimeval.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,10 +69,18 @@
<Parameter Name="millis" Type="System.Int64" />
</Parameters>
<Docs>
<param name="millis">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="millis">The value to represent, in milliseconds.</param>
<summary>Creates a <c>StructTimeval</c> from a millisecond value.</summary>
<returns>A value whose seconds and microseconds components represent <paramref name="millis" />.</returns>
<remarks>
<para>For negative values, the seconds component is rounded down and the microseconds component remains non-negative.</para>
<para>
<format type="text/html">
<a href="https://android.googlesource.com/platform/libcore/+/de876a01b29230b877c9f408348c38a90ee724a5/luni/src/main/java/android/system/StructTimeval.java#41" title="Source code">AOSP source for <code>StructTimeval.fromMillis(long)</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://source.android.com/" 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://www.apache.org/licenses/LICENSE-2.0" title="Apache License 2.0">Apache License 2.0.</a></format></para>
</remarks>
</Docs>
</Member>
<Member MemberName="JniPeerMembers">
Expand Down Expand Up @@ -187,9 +195,16 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<summary>Converts this value to milliseconds.</summary>
<returns>The seconds component multiplied by 1,000 plus the microseconds component divided by 1,000 using integer division; sub-millisecond microseconds are truncated.</returns>
<remarks>
<para>
<format type="text/html">
<a href="https://android.googlesource.com/platform/libcore/+/de876a01b29230b877c9f408348c38a90ee724a5/luni/src/main/java/android/system/StructTimeval.java#53" title="Source code">AOSP source for <code>StructTimeval.toMillis()</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://source.android.com/" 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://www.apache.org/licenses/LICENSE-2.0" title="Apache License 2.0">Apache License 2.0.</a></format></para>
</remarks>
</Docs>
</Member>
<Member MemberName="TvSec">
Expand Down Expand Up @@ -217,7 +232,7 @@
</ReturnValue>
<Docs>
<summary>Seconds.</summary>
<value>To be added.</value>
<value>The seconds component.</value>
<remarks>
<para>Seconds.</para>
<para>
Expand Down Expand Up @@ -258,7 +273,7 @@
</ReturnValue>
<Docs>
<summary>Microseconds.</summary>
<value>To be added.</value>
<value>The microseconds component.</value>
<remarks>
<para>Microseconds.</para>
<para>
Expand Down