Add symtab/Type-mem.h

dyninst · Apr 3, 2024 · ba36b11 · ba36b11
1 parent 90eb97e
commit ba36b11
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 4 deletions.
diff --git a/docs/symtabAPI/developer/Type-mem.h.rst b/docs/symtabAPI/developer/Type-mem.h.rst
@@ -1,5 +1,22 @@
+.. _`sec:Type-mem.h`:
+
 Type-mem.h
 ##########
 
 .. cpp:namespace:: Dyninst::SymtabAPI
 
+.. cpp:function:: template<class T> T *upgradePlaceholder(Type *placeholder, T *new_type)
+
+.. cpp:namespace-push:: dev
+
+.. cpp:function:: template<class T> typename boost::enable_if<\
+                    boost::integral_constant<bool, !bool(boost::is_same<Type, T>::value)>, \
+                    boost::shared_ptr<Type>>::type \
+                    typeCollection::addOrUpdateType(boost::shared_ptr<T> type)
+
+  Instantiating this function for ``Type`` would be a mistake, which
+  the following assert tries to guard against.  If you trigger this,
+  then a caller to this function is likely using ``Type``.  Change
+  this to a more specific call, e.g. :cpp:class:`typeFunction` instead of ``Type``.
+
+.. cpp:namespace-pop::
diff --git a/symtabAPI/src/Type-mem.h b/symtabAPI/src/Type-mem.h
@@ -57,10 +57,6 @@ typename boost::enable_if<
     boost::integral_constant<bool, !bool(boost::is_same<Type, T>::value)>,
 boost::shared_ptr<Type>>::type typeCollection::addOrUpdateType(boost::shared_ptr<T> type)
 {
-	//Instanciating this function for 'Type' would be a mistake, which
-	//the following assert tries to guard against.  If you trigger this,
-	//then a caller to this function is likely using 'Type'.  Change
-	//this to a more specific call, e.g. typeFunction instead of Type
     // NOTE: Disabled, we use SFINAE instead to handle this.
     // BOOST_STATIC_ASSERT(sizeof(T) != sizeof(Type));