From 276f13af1466c4c746bac6d7b39b27ab2180f712 Mon Sep 17 00:00:00 2001
From: Jan Travnicek <Jan.Travnicek@fit.cvut.cz>
Date: Thu, 21 Jun 2018 20:09:57 +0200
Subject: [PATCH] some more missing documentation
---
alib2common/src/base/CommonBase.hpp | 2 ++
alib2common/src/base/WrapperBase.hpp | 7 +++++++
2 files changed, 9 insertions(+)
diff --git a/alib2common/src/base/CommonBase.hpp b/alib2common/src/base/CommonBase.hpp
index 71aea020a2..baa2cd2009 100644
--- a/alib2common/src/base/CommonBase.hpp
+++ b/alib2common/src/base/CommonBase.hpp
@@ -179,6 +179,8 @@ namespace ext {
/**
* Helper for comparing everything that inherits from CommonBaseBase.
+ *
+ * \tparam T the type to compare
*/
template < class T >
struct compare < T, typename std::enable_if < std::is_base_of < base::CommonBaseBase, typename std::decay < T >::type >::value >::type > {
diff --git a/alib2common/src/base/WrapperBase.hpp b/alib2common/src/base/WrapperBase.hpp
index da25651996..56046d668a 100644
--- a/alib2common/src/base/WrapperBase.hpp
+++ b/alib2common/src/base/WrapperBase.hpp
@@ -33,9 +33,16 @@ public:
template < typename T >
class WrapperBaseMiddle : public WrapperBaseBase {
protected:
+ /**
+ * The wrapped data.
+ */
ext::cow_shared_ptr < T > m_data;
private:
+ /**
+ * \brief
+ * Unifies the shared pointers. For internal use when two pointer eval equal.
+ */
void unify ( WrapperBaseMiddle & other ) {
if ( this->m_data.getUseCount ( ) > other.m_data.getUseCount ( ) )
other.m_data = this->m_data;
--
GitLab