Imported Upstream version 1.72.0

[platform/upstream/boost.git] / libs / date_time / xmldoc / time_duration.xml

diff --git a/libs/date_time/xmldoc/time_duration.xml b/libs/date_time/xmldoc/time_duration.xml
index c31fb4d..fde1387 100644 (file)
--- a/libs/date_time/xmldoc/time_duration.xml
+++ b/libs/date_time/xmldoc/time_duration.xml
@@ -256,7 +256,7 @@ neg_td.minutes(); // --> -2</screen></entry>
         </row>
         
          <row>
-           <entry valign="top" morerows="1"><screen>boost::int64_t seconds()</screen></entry>
+           <entry valign="top" morerows="1"><screen>boost::int64_t seconds() const</screen></entry>
             <entry>Get the normalized number of second +/-(0..59) (will give unpredictable results if calling <code>time_duration</code> is a <code>special_value</code>).</entry>
          </row>
          <row>
@@ -267,7 +267,7 @@ neg_td.seconds(); // --> -3</screen></entry>
         </row>
         
          <row>
-           <entry valign="top" morerows="1"><screen>boost::int64_t total_seconds()</screen></entry>
+           <entry valign="top" morerows="1"><screen>boost::int64_t total_seconds() const</screen></entry>
            <entry>Get the total number of seconds truncating any fractional seconds (will give unpredictable results if calling <code>time_duration</code> is a <code>special_value</code>).</entry>
          </row>
          <row>
@@ -278,7 +278,7 @@ td.total_seconds();
           </row>
           
          <row>
-           <entry valign="top" morerows="1"><screen>boost::int64_t total_milliseconds()</screen></entry>
+           <entry valign="top" morerows="1"><screen>boost::int64_t total_milliseconds() const</screen></entry>
            <entry>Get the total number of milliseconds truncating any remaining digits (will give unpredictable results if calling <code>time_duration</code> is a <code>special_value</code>).</entry>
          </row>
          <row>
@@ -291,7 +291,7 @@ td.total_milliseconds();
           </row>
           
          <row>
-           <entry valign="top" morerows="1"><screen>boost::int64_t total_microseconds()</screen></entry>
+           <entry valign="top" morerows="1"><screen>boost::int64_t total_microseconds() const</screen></entry>
            <entry>Get the total number of microseconds truncating any remaining digits (will give unpredictable results if calling <code>time_duration</code> is a <code>special_value</code>).</entry>
          </row>
          <row>
@@ -304,7 +304,7 @@ td.total_microseconds();
           </row>
           
          <row>
-           <entry valign="top" morerows="1"><screen>boost::int64_t total_nanoseconds()</screen></entry>
+           <entry valign="top" morerows="1"><screen>boost::int64_t total_nanoseconds() const</screen></entry>
            <entry>Get the total number of nanoseconds truncating any remaining digits (will give unpredictable results if calling <code>time_duration</code> is a <code>special_value</code>).</entry>
          </row>
          <row>
@@ -318,7 +318,7 @@ td.total_nanoseconds();
           </row>
           
          <row>
-           <entry valign="top" morerows="1"><screen>boost::int64_t fractional_seconds()</screen></entry>
+           <entry valign="top" morerows="1"><screen>boost::int64_t fractional_seconds() const</screen></entry>
            <entry>Get the number of fractional seconds (will give unpredictable results if calling <code>time_duration</code> is a <code>special_value</code>).</entry>
          </row>
          <row>
@@ -327,8 +327,8 @@ td.fractional_seconds(); // --> 1000</screen></entry>
           </row>
           
          <row>
-           <entry valign="top" morerows="1"><screen>bool is_negative()</screen></entry>
-           <entry>True if duration is negative.</entry>
+           <entry valign="top" morerows="1"><screen>bool is_negative() const</screen></entry>
+           <entry>True if and only if duration is negative.</entry>
          </row>
          <row>
             <entry><screen>time_duration td(-1,0,0); 
@@ -336,16 +336,45 @@ td.is_negative(); // --> true</screen></entry>
           </row>
           
          <row>
-           <entry valign="top" morerows="1"><screen>time_duration invert_sign()</screen></entry>
-           <entry>Generate a new duration with the sign inverted/</entry>
+           <entry valign="top" morerows="1"><screen>bool is_zero() const</screen></entry>
+           <entry>True if and only if duration is zero.</entry>
          </row>
          <row>
-            <entry><screen>time_duration td(-1,0,0); 
+            <entry><screen>time_duration td(0,0,0);
+td.is_zero(); // --> true</screen></entry>
+          </row>
+
+         <row>
+           <entry valign="top" morerows="1"><screen>bool is_positive() const</screen></entry>
+           <entry>True if and only if duration is positive.</entry>
+         </row>
+         <row>
+            <entry><screen>time_duration td(1,0,0);
+td.is_positive(); // --> true</screen></entry>
+          </row>
+
+         <row>
+           <entry valign="top" morerows="1"><screen>time_duration invert_sign() const</screen></entry>
+           <entry>Generate a new duration with the sign inverted.</entry>
+         </row>
+         <row>
+            <entry><screen>time_duration td(-1,0,0);
 td.invert_sign(); // --> 01:00:00</screen></entry>
           </row>
           
          <row>
-           <entry valign="top" morerows="1"><screen>date_time::time_resolutions resolution()</screen></entry>
+           <entry valign="top" morerows="1"><screen>time_duration abs() const</screen></entry>
+           <entry>Generate a new duration with the absolute value of the time duration.</entry>
+         </row>
+         <row>
+            <entry><screen>time_duration td(-1,0,0);
+td.abs(); // --> 01:00:00</screen></entry>
+            <entry><screen>time_duration td(+1,0,0);
+td.abs(); // --> 01:00:00</screen></entry>
+          </row>
+
+         <row>
+           <entry valign="top" morerows="1"><screen>date_time::time_resolutions time_duration::resolution()</screen></entry>
             <entry>Describes the resolution capability of the time_duration class. time_resolutions is an enum of resolution possibilities ranging from seconds to nanoseconds.</entry>
          </row>
          <row>
@@ -353,8 +382,8 @@ td.invert_sign(); // --> 01:00:00</screen></entry>
           </row>
           
          <row>
-            <entry valign="top" morerows="1"><screen>time_duration::num_fractional_digits()</screen></entry>
-            <entry>Returns an unsigned short holding the number of fractional digits the time resolution has.</entry>
+            <entry valign="top" morerows="1"><screen>unsigned short time_duration::num_fractional_digits()</screen></entry>
+            <entry>Returns the number of fractional digits the time resolution has.</entry>
          </row>
          <row>
             <entry><screen>unsigned short secs;
@@ -363,7 +392,7 @@ secs = time_duration::num_fractional_digits();
           </row>
           
          <row>
-            <entry valign="top" morerows="1"><screen>time_duration::ticks_per_second()</screen></entry>
+            <entry valign="top" morerows="1"><screen>boost::int64_t time_duration::ticks_per_second()</screen></entry>
             <entry>Return the number of ticks in a second.  For example, if the duration supports nanoseconds then the returned result will be 1,000,000,000 (1e+9).</entry>
          </row>
          <row>
@@ -380,7 +409,7 @@ td.ticks() // --> 1000</screen></entry>
           </row>
           
           <row>
-           <entry valign="top" morerows="1"><screen>time_duration unit()</screen></entry>
+           <entry valign="top" morerows="1"><screen>time_duration time_duration::unit()</screen></entry>
            <entry>Return smallest possible unit of duration type (1 nanosecond).</entry>
          </row>
          <row>