]> git.ipfire.org Git - thirdparty/gcc.git/commitdiff
libstdc++: Fix Doxygen comments on chrono::floor etc.
authorJonathan Wakely <jwakely@redhat.com>
Wed, 1 Apr 2026 16:06:21 +0000 (17:06 +0100)
committerJonathan Wakely <redi@gcc.gnu.org>
Thu, 2 Apr 2026 12:59:57 +0000 (13:59 +0100)
libstdc++-v3/ChangeLog:

* include/bits/chrono.h (floor, ceil, round): Fix Doxygen
comments to use correct parameter name and describe return value
more accurately.

Reviewed-by: Tomasz KamiƄski <tkaminsk@redhat.com>
libstdc++-v3/include/bits/chrono.h

index 911cc791ca0e3a9fe47454ab110faaa0023239d6..fd91505c16f400a7ec1dfcbdeab33faf8a628df6 100644 (file)
@@ -1035,8 +1035,8 @@ _GLIBCXX_BEGIN_NAMESPACE_VERSION
      * returns the closest value that is less than the argument.
      *
      * @tparam _ToDur The `duration` type to use for the result.
-     * @param __t A time point.
-     * @return The value of `__d` converted to type `_ToDur`.
+     * @param __tp A time point.
+     * @return The value of `__tp` rounded down to the precision of `_ToDur`.
      * @since C++17
      */
     template<typename _ToDur, typename _Clock, typename _Dur>
@@ -1056,8 +1056,8 @@ _GLIBCXX_BEGIN_NAMESPACE_VERSION
      * returns the closest value that is greater than the argument.
      *
      * @tparam _ToDur The `duration` type to use for the result.
-     * @param __t A time point.
-     * @return The value of `__d` converted to type `_ToDur`.
+     * @param __tp A time point.
+     * @return The value of `__tp` rounded up to the precision of `_ToDur`.
      * @since C++17
      */
     template<typename _ToDur, typename _Clock, typename _Dur>
@@ -1078,8 +1078,8 @@ _GLIBCXX_BEGIN_NAMESPACE_VERSION
      *
      * @tparam _ToDur The `duration` type to use for the result,
      *                which must have a non-floating-point `rep` type.
-     * @param __t A time point.
-     * @return The value of `__d` converted to type `_ToDur`.
+     * @param __tp A time point.
+     * @return The value of `__tp` rounded to the precision `_ToDur`.
      * @since C++17
      */
     template<typename _ToDur, typename _Clock, typename _Dur>