[Boost-bugs] [Boost C++ Libraries] #12184: clang -Wdocumentation warning

Subject: [Boost-bugs] [Boost C++ Libraries] #12184: clang -Wdocumentation warning
From: Boost C++ Libraries (noreply_at_[hidden])
Date: 2016-05-09 10:20:39

#12184: clang -Wdocumentation warning
------------------------------+------------------------
 Reporter:  gonzalobg88@…     |      Owner:  igaztanaga
     Type:  Bugs              |     Status:  new
Milestone:  To Be Determined  |  Component:  intrusive
  Version:  Boost 1.61.0      |   Severity:  Cosmetic
 Keywords:                    |
------------------------------+------------------------
 I get the following documentation warning (-Wdocumentation) with clang:

 include/boost/intrusive/slist.hpp:1208:55: warning: not a Doxygen trailing
 comment [-Wdocumentation]
          const_iterator last_x(x.previous(x.end()));  //<- constant time
 if cache_last is active
                                                       ^~~~
                                                       ///<

 It's not serious but since "//<" looks like, but is not, a Doxygen
 documentation comment clang warns about it. Switching from "//<" to "//"
 in the following line resolves the issue for me:

 https://github.com/boostorg/intrusive/blob/develop/include/boost/intrusive/slist.hpp#L1268

-- 
Ticket URL: <https://svn.boost.org/trac/boost/ticket/12184>
Boost C++ Libraries <http://www.boost.org/>
Boost provides free peer-reviewed portable C++ source libraries.