Change naming convention for C++ interfaces

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

diff --git a/src/gromacs/onlinehelp/helptopicinterface.h b/src/gromacs/onlinehelp/ihelptopic.h
similarity index 90%
rename from src/gromacs/onlinehelp/helptopicinterface.h
rename to src/gromacs/onlinehelp/ihelptopic.h
index 79dfbc390be04a666908103e9e3c6cb07079a2a0..edb9343d328ae251df40a49db753b7c2863785f4 100644 (file)
--- a/src/gromacs/onlinehelp/helptopicinterface.h
+++ b/src/gromacs/onlinehelp/ihelptopic.h
@@ -34,14 +34,14 @@
  */
 /*! \libinternal \file
  * \brief
- * Declares gmx::HelpTopicInterface.
+ * Declares gmx::IHelpTopic.
  *
  * \author Teemu Murtola <teemu.murtola@gmail.com>
  * \inlibraryapi
  * \ingroup module_onlinehelp
  */
-#ifndef GMX_ONLINEHELP_HELPTOPICINTERFACE_H
-#define GMX_ONLINEHELP_HELPTOPICINTERFACE_H
+#ifndef GMX_ONLINEHELP_IHELPTOPIC_H
+#define GMX_ONLINEHELP_IHELPTOPIC_H
 
 #include "gromacs/utility/uniqueptr.h"
 
@@ -63,10 +63,10 @@ class HelpWriterContext;
  * \inlibraryapi
  * \ingroup module_onlinehelp
  */
-class HelpTopicInterface
+class IHelpTopic
 {
     public:
-        virtual ~HelpTopicInterface() {}
+        virtual ~IHelpTopic() {}
 
         /*! \brief
          * Returns the name of the topic.
@@ -93,7 +93,7 @@ class HelpTopicInterface
          * \returns   Pointer to the found subtopic, or NULL if matching topic
          *      is not found.
          */
-        virtual const HelpTopicInterface *findSubTopic(const char *name) const = 0;
+        virtual const IHelpTopic *findSubTopic(const char *name) const = 0;
 
         /*! \brief
          * Prints the help text for this topic.
@@ -105,8 +105,8 @@ class HelpTopicInterface
         virtual void writeHelp(const HelpWriterContext &context) const = 0;
 };
 
-//! Smart pointer type to manage a HelpTopicInterface object.
-typedef gmx_unique_ptr<HelpTopicInterface>::type HelpTopicPointer;
+//! Smart pointer type to manage a IHelpTopic object.
+typedef gmx_unique_ptr<IHelpTopic>::type HelpTopicPointer;
 
 } // namespace gmx