]> git.ipfire.org Git - thirdparty/gcc.git/commitdiff
libstdc++: Fix Doxygen warning
authorJonathan Wakely <jwakely@redhat.com>
Thu, 17 Nov 2022 10:20:50 +0000 (10:20 +0000)
committerJonathan Wakely <jwakely@redhat.com>
Sat, 19 Nov 2022 15:05:28 +0000 (15:05 +0000)
This fixes a Doxygen warning about a mismatched parameter name. The
standard uses 'r' here, like the Doxygen comment, so use '__r' instead
of '__e'.

libstdc++-v3/ChangeLog:

* include/bits/ptr_traits.h (pointer_traits::pointer_to): Rename
parameter.

libstdc++-v3/include/bits/ptr_traits.h

index 71370ff4fc9422a8efee0227de3a4bc8771530d2..b46a1ac34c90c7ef5e5debbeff078ab0246b0b4c 100644 (file)
@@ -104,17 +104,17 @@ _GLIBCXX_BEGIN_NAMESPACE_VERSION
       /**
        *  @brief  Obtain a pointer to an object
        *  @param  __r  A reference to an object of type `element_type`
-       *  @return `pointer::pointer_to(__e)`
-       *  @pre `pointer::pointer_to(__e)` is a valid expression.
+       *  @return `pointer::pointer_to(__r)`
+       *  @pre `pointer::pointer_to(__r)` is a valid expression.
       */
       static pointer
-      pointer_to(element_type& __e)
+      pointer_to(element_type& __r)
 #if __cpp_lib_concepts
       requires requires {
-       { pointer::pointer_to(__e) } -> convertible_to<pointer>;
+       { pointer::pointer_to(__r) } -> convertible_to<pointer>;
       }
 #endif
-      { return pointer::pointer_to(__e); }
+      { return pointer::pointer_to(__r); }
     };
 
   // Do not define pointer_traits<P>::pointer_to if element type is void.