Change naming convention for C++ interfaces

[alexxy/gromacs.git] / src / gromacs / onlinehelp / helptopic.h

diff --git a/src/gromacs/onlinehelp/helptopic.h b/src/gromacs/onlinehelp/helptopic.h
index 3a49e39bd0dc0fd311680f283f272c35070e9ac2..d9027d6a57a561efd412139df36a2ae2addfb052 100644 (file)
--- a/src/gromacs/onlinehelp/helptopic.h
+++ b/src/gromacs/onlinehelp/helptopic.h
@@ -34,7 +34,7 @@
  */
 /*! \libinternal \file
  * \brief
- * Declares helper classes for implementing gmx::HelpTopicInterface.
+ * Declares helper classes for implementing gmx::IHelpTopic.
  *
  * \author Teemu Murtola <teemu.murtola@gmail.com>
  * \inlibraryapi
@@ -43,7 +43,7 @@
 #ifndef GMX_ONLINEHELP_HELPTOPIC_H
 #define GMX_ONLINEHELP_HELPTOPIC_H
 
-#include "gromacs/onlinehelp/helptopicinterface.h"
+#include "gromacs/onlinehelp/ihelptopic.h"
 #include "gromacs/utility/classhelpers.h"
 #include "gromacs/utility/stringutil.h"
 #include "gromacs/utility/uniqueptr.h"
@@ -54,7 +54,7 @@ namespace gmx
 /*! \libinternal \brief
  * Abstract base class for help topics that have simple text and no subtopics.
  *
- * This class implements subtopic-related methods from HelpTopicInterface such
+ * This class implements subtopic-related methods from IHelpTopic such
  * that there are no subtopics.  writeHelp() is also implemented such that it
  * uses HelpTopicContext::writeTextBlock() to write out the text returned by a
  * new virtual method helpText().
@@ -64,14 +64,14 @@ namespace gmx
  * \inlibraryapi
  * \ingroup module_onlinehelp
  */
-class AbstractSimpleHelpTopic : public HelpTopicInterface
+class AbstractSimpleHelpTopic : public IHelpTopic
 {
     public:
         virtual const char *name() const  = 0;
         virtual const char *title() const = 0;
 
         virtual bool hasSubTopics() const;
-        virtual const HelpTopicInterface *findSubTopic(const char *name) const;
+        virtual const IHelpTopic *findSubTopic(const char *name) const;
 
         virtual void writeHelp(const HelpWriterContext &context) const;
 
@@ -90,8 +90,8 @@ class AbstractSimpleHelpTopic : public HelpTopicInterface
  * Abstract base class for help topics that have simple text and subtopics.
  *
  * This class implements an internal container for subtopics and provides
- * public methods for adding subtopics (as HelpTopicInterface objects).
- * Subtopic-related methods from HelpTopicInterface are implemented to access
+ * public methods for adding subtopics (as IHelpTopic objects).
+ * Subtopic-related methods from IHelpTopic are implemented to access
  * the internal container.  writeHelp() is also implemented such that it
  * uses HelpTopicContext::writeTextBlock() to write out the text returned by a
  * new virtual method helpText(), and a list of subtopics is written after the
@@ -102,7 +102,7 @@ class AbstractSimpleHelpTopic : public HelpTopicInterface
  * \inlibraryapi
  * \ingroup module_onlinehelp
  */
-class AbstractCompositeHelpTopic : public HelpTopicInterface
+class AbstractCompositeHelpTopic : public IHelpTopic
 {
     public:
         AbstractCompositeHelpTopic();
@@ -112,7 +112,7 @@ class AbstractCompositeHelpTopic : public HelpTopicInterface
         virtual const char *title() const = 0;
 
         virtual bool hasSubTopics() const;
-        virtual const HelpTopicInterface *findSubTopic(const char *name) const;
+        virtual const IHelpTopic *findSubTopic(const char *name) const;
 
         virtual void writeHelp(const HelpWriterContext &context) const;
 
@@ -134,7 +134,7 @@ class AbstractCompositeHelpTopic : public HelpTopicInterface
          * \throws  std::bad_alloc if out of memory.
          *
          * \p Topic must be default-constructible and implement
-         * HelpTopicInterface.
+         * IHelpTopic.
          *
          * This method is provided as a convenient alternative to addSubTopic()
          * for cases where each topic is implemented by a different type