From 423f3d700071d787b4cb3f457cc5da7f3fdf6584 Mon Sep 17 00:00:00 2001 From: Oliver Ruebel Date: Wed, 2 Oct 2024 15:13:11 -0700 Subject: [PATCH] Apply suggestions on docs from code review Co-authored-by: Steph Prince <40640337+stephprince@users.noreply.github.com> --- docs/pages/devdocs/registered_types.dox | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/pages/devdocs/registered_types.dox b/docs/pages/devdocs/registered_types.dox index 820d7de..7c376ac 100644 --- a/docs/pages/devdocs/registered_types.dox +++ b/docs/pages/devdocs/registered_types.dox @@ -15,7 +15,7 @@ * * To implement a subclass of \ref AQNWB::NWB::RegisteredType "RegisteredType", follow these steps: * - * 1. Include the `RegisteredType.h` header file in your subclass header file. + * 1. Include the `RegisteredType.hpp` header file in your subclass header file. * @code * #include "nwb/RegisteredType.hpp" * @endcode @@ -82,10 +82,10 @@ * * @subsection implement_registered_type_example Example: Implementing a new type * - * *MySubClass.h* + * *MySubClass.hpp* * @code * #pragma once - * #include "RegisteredType.h" + * #include "RegisteredType.hpp" * * class MySubClass : public AQNWB::NWB::RegisteredType * { @@ -136,8 +136,8 @@ * * 5. **Class Name and Namespace Retrieval**: * - The \ref AQNWB::NWB::RegisteredType::getTypeName "getTypeName" and - * \ref AQNWB::NWB::RegisteredType::getNamespace "getNamespace" return the string name the - * class and namespace, respectively. The `REGISTER_SUBCLASS` macro implements and automatic + * \ref AQNWB::NWB::RegisteredType::getNamespace "getNamespace" return the string name of the + * class and namespace, respectively. The `REGISTER_SUBCLASS` macro implements an automatic * override of the methods to ensure the appropriate type and namespace string are returned. * These methods should, hence, not be manually overridden by subclasses, to ensure consistency * in type identification.