Fix a few minor typos in documentation

AIDASoft · Sep 26, 2024 · 861b564 · 861b564
1 parent 5c40955
commit 861b564
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 13 deletions.
diff --git a/include/podio/detail/Link.h b/include/podio/detail/Link.h
@@ -17,7 +17,7 @@ namespace podio {
 
 /// Generalized Link type for both Mutable and immutable (default)
 /// versions. User facing clases with the expected naming scheme are defined via
-/// template aliases are defined just below
+/// template aliases in LinkFwd.h
 template <typename FromT, typename ToT, bool Mutable>
 class LinkT {
   // The typedefs in LinkFwd.h should make sure that at this point
@@ -76,7 +76,7 @@ class LinkT {
   /// Implicit conversion of mutable to immutable links
   template <typename FromU, typename ToU, typename = std::enable_if_t<Mutable && sameTypes<FromU, ToU>>>
   operator LinkT<FromU, ToU, false>() const {
-    return LinkT<FromU, ToU, false>(m_obj);
+    return Link<FromU, ToU>(m_obj);
   }
 
   /// Create a mutable deep-copy

diff --git a/include/podio/detail/LinkFwd.h b/include/podio/detail/LinkFwd.h
@@ -12,7 +12,7 @@
 namespace podio {
 namespace detail {
 
-  /// Get the collection type name for an LinkCollection
+  /// Get the collection type name for a LinkCollection
   ///
   /// @tparam FromT the From type of the link
   /// @tparam ToT the To type of the link
@@ -24,7 +24,7 @@ namespace detail {
     return std::string_view{typeName};
   }
 
-  /// Get the value type name for an LinkCollection
+  /// Get the value type name for a LinkCollection
   ///
   /// @tparam FromT the From type of the link
   /// @tparam ToT the To type of the link
@@ -35,14 +35,13 @@ namespace detail {
     return std::string_view{typeName};
   }
 
-  /// Get an SIO friendly type name for an LinkCollection (necessary for
+  /// Get an SIO friendly type name for a LinkCollection (necessary for
   /// registration in the SIOBlockFactory)
   ///
   /// @tparam FromT the From type of the link
-  /// @tparam ToT the To type of
-  /// the link
-  /// @returns a string that uniquely identifies this combination
-  /// of From and To types
+  /// @tparam ToT the To type of the link
+  /// @returns a string that uniquely identifies this combination of From and To
+  /// types
   template <typename FromT, typename ToT>
   inline const std::string& linkSIOName() {
     static auto n = std::string("LINK_FROM_") + FromT::typeName + "_TO_" + ToT::typeName;
@@ -51,8 +50,7 @@ namespace detail {
   }
 } // namespace detail
 
-// Forward declarations and typedefs used throughout the whole Link
-// business
+// Forward declarations and typedefs used throughout the whole Link business
 template <typename FromT, typename ToT>
 class LinkObj;
 
@@ -94,11 +92,11 @@ using LinkMutableCollectionIterator = LinkCollectionIteratorT<FromT, ToT, true>;
 } // namespace podio
 
 namespace std {
-/// Specialization for enabling structure bindings for Links
+/// Specialization for enabling structured bindings for Links
 template <typename F, typename T, bool M>
 struct tuple_size<podio::LinkT<F, T, M>> : std::integral_constant<size_t, 3> {};
 
-/// Specialization for enabling structure bindings for Links
+/// Specialization for enabling structured bindings for Links
 template <size_t Index, typename F, typename T, bool M>
 struct tuple_element<Index, podio::LinkT<F, T, M>> : tuple_element<Index, std::tuple<F, T, float>> {};
 } // namespace std