From 861b564e3c6a921563fc9a9b226a9f4efa956aaf Mon Sep 17 00:00:00 2001 From: tmadlener Date: Thu, 26 Sep 2024 10:28:32 +0200 Subject: [PATCH] Fix a few minor typos in documentation --- include/podio/detail/Link.h | 4 ++-- include/podio/detail/LinkFwd.h | 20 +++++++++----------- 2 files changed, 11 insertions(+), 13 deletions(-) diff --git a/include/podio/detail/Link.h b/include/podio/detail/Link.h index e75f7ca79..524ee305f 100644 --- 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 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 >> operator LinkT() const { - return LinkT(m_obj); + return Link(m_obj); } /// Create a mutable deep-copy diff --git a/include/podio/detail/LinkFwd.h b/include/podio/detail/LinkFwd.h index 3ef706251..254447ef7 100644 --- 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 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 class LinkObj; @@ -94,11 +92,11 @@ using LinkMutableCollectionIterator = LinkCollectionIteratorT; } // namespace podio namespace std { -/// Specialization for enabling structure bindings for Links +/// Specialization for enabling structured bindings for Links template struct tuple_size> : std::integral_constant {}; -/// Specialization for enabling structure bindings for Links +/// Specialization for enabling structured bindings for Links template struct tuple_element> : tuple_element> {}; } // namespace std