X-Git-Url: http://biod.pnpi.spb.ru/gitweb/?a=blobdiff_plain;f=src%2Fgromacs%2Fonlinehelp%2Fhelptopic.h;h=d9027d6a57a561efd412139df36a2ae2addfb052;hb=7a6907d2184cf7bf3ce09e83e9d902f9787a3eb0;hp=3a49e39bd0dc0fd311680f283f272c35070e9ac2;hpb=9eb0581bed7c5147f8919ab19a7e2ed55e0e1514;p=alexxy%2Fgromacs.git diff --git a/src/gromacs/onlinehelp/helptopic.h b/src/gromacs/onlinehelp/helptopic.h index 3a49e39bd0..d9027d6a57 100644 --- 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 * \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