From 61ec50dabe14c5d4582ac187706ea27645b3562b Mon Sep 17 00:00:00 2001 From: Jeffrey Walton Date: Wed, 29 Nov 2017 10:54:33 -0500 Subject: Change Doxygen comment style from //! to /// Also see https://groups.google.com/forum/#!topic/cryptopp-users/A7-Xt5Knlzw --- smartptr.h | 82 +++++++++++++++++++++++++++++++------------------------------- 1 file changed, 41 insertions(+), 41 deletions(-) (limited to 'smartptr.h') diff --git a/smartptr.h b/smartptr.h index cc7874fb..e5ee7705 100644 --- a/smartptr.h +++ b/smartptr.h @@ -1,8 +1,8 @@ // smartptr.h - originally written and placed in the public domain by Wei Dai -//! \file -//! \headerfile smartptr.h -//! \brief Classes for automatic resource management +/// \file +/// \headerfile smartptr.h +/// \brief Classes for automatic resource management #ifndef CRYPTOPP_SMARTPTR_H #define CRYPTOPP_SMARTPTR_H @@ -12,11 +12,11 @@ NAMESPACE_BEGIN(CryptoPP) -//! \class simple_ptr -//! \brief Manages resources for a single object -//! \tparam T class or type -//! \details \p simple_ptr is used frequently in the library to manage resources and -//! ensure cleanup under the RAII pattern (Resource Acquisition Is Initialization). +/// \class simple_ptr +/// \brief Manages resources for a single object +/// \tparam T class or type +/// \details \p simple_ptr is used frequently in the library to manage resources and +/// ensure cleanup under the RAII pattern (Resource Acquisition Is Initialization). template class simple_ptr { public: @@ -30,12 +30,12 @@ public: T *m_p; }; -//! \class member_ptr -//! \brief Pointer that overloads operator -> -//! \tparam T class or type -//! \details member_ptr is used frequently in the library to avoid the issues related to -//! std::auto_ptr in C++11 (deprecated) and std::unique_ptr in C++03 (non-existent). -//! \bug Issue 48: "Use of auto_ptr causes dirty compile under C++11" +/// \class member_ptr +/// \brief Pointer that overloads operator -> +/// \tparam T class or type +/// \details member_ptr is used frequently in the library to avoid the issues related to +/// std::auto_ptr in C++11 (deprecated) and std::unique_ptr in C++03 (non-existent). +/// \bug Issue 48: "Use of auto_ptr causes dirty compile under C++11" template class member_ptr { public: @@ -73,9 +73,9 @@ template void member_ptr::reset(T *p) {delete m_p; m_p = p;} // ******************************************************** -//! \class value_ptr -//! \brief Value pointer -//! \tparam T class or type +/// \class value_ptr +/// \brief Value pointer +/// \tparam T class or type template class value_ptr : public member_ptr { public: @@ -101,10 +101,10 @@ template value_ptr& value_ptr::operator=(const value_ptr& rhs // ******************************************************** -//! \class clonable_ptr -//! \brief A pointer which can be copied and cloned -//! \tparam T class or type -//! \details \p T should adhere to the \p Clonable interface +/// \class clonable_ptr +/// \brief A pointer which can be copied and cloned +/// \tparam T class or type +/// \details \p T should adhere to the \p Clonable interface template class clonable_ptr : public member_ptr { public: @@ -126,11 +126,11 @@ template clonable_ptr& clonable_ptr::operator=(const clonable_pt // ******************************************************** -//! \class counted_ptr -//! \brief Reference counted pointer -//! \tparam T class or type -//! \details users should declare \p m_referenceCount as std::atomic -//! (or similar) under C++ 11 +/// \class counted_ptr +/// \brief Reference counted pointer +/// \tparam T class or type +/// \details users should declare \p m_referenceCount as std::atomic +/// (or similar) under C++ 11 template class counted_ptr { public: @@ -220,18 +220,18 @@ template counted_ptr & counted_ptr::operator=(const counted_ptr< // ******************************************************** -//! \class vector_ptr -//! \brief Manages resources for an array of objects -//! \tparam T class or type -//! \details \p vector_ptr is used frequently in the library to avoid large stack allocations, -//! and manage resources and ensure cleanup under the RAII pattern (Resource Acquisition -//! Is Initialization). +/// \class vector_ptr +/// \brief Manages resources for an array of objects +/// \tparam T class or type +/// \details \p vector_ptr is used frequently in the library to avoid large stack allocations, +/// and manage resources and ensure cleanup under the RAII pattern (Resource Acquisition +/// Is Initialization). template class vector_ptr { public: - //! Construct an arry of \p T - //! \param size the size of the array, in elements - //! \details If \p T is a Plain Old Dataype (POD), then the array is uninitialized. + /// Construct an arry of \p T + /// \param size the size of the array, in elements + /// \details If \p T is a Plain Old Dataype (POD), then the array is uninitialized. vector_ptr(size_t size=0) : m_size(size), m_ptr(new T[m_size]) {} ~vector_ptr() @@ -278,15 +278,15 @@ private: // ******************************************************** -//! \class vector_member_ptrs -//! \brief Manages resources for an array of objects -//! \tparam T class or type +/// \class vector_member_ptrs +/// \brief Manages resources for an array of objects +/// \tparam T class or type template class vector_member_ptrs { public: - //! Construct an arry of \p T - //! \param size the size of the array, in elements - //! \details If \p T is a Plain Old Dataype (POD), then the array is uninitialized. + /// Construct an arry of \p T + /// \param size the size of the array, in elements + /// \details If \p T is a Plain Old Dataype (POD), then the array is uninitialized. vector_member_ptrs(size_t size=0) : m_size(size), m_ptr(new member_ptr[size]) {} ~vector_member_ptrs() -- cgit v1.2.1