Apply clang-format to source tree

[alexxy/gromacs.git] / src / gromacs / commandline / cmdlinehelpmodule.h

diff --git a/src/gromacs/commandline/cmdlinehelpmodule.h b/src/gromacs/commandline/cmdlinehelpmodule.h
index 8ff0bdeb825ea215ddeeedb8a1a96e7ce36527ee..02b07170359ba2ee86fd28616d9be55ce3e4f4dc 100644 (file)
--- a/src/gromacs/commandline/cmdlinehelpmodule.h
+++ b/src/gromacs/commandline/cmdlinehelpmodule.h
@@ -68,79 +68,72 @@ class CommandLineHelpModuleImpl;
  */
 class CommandLineHelpModule : public ICommandLineModule
 {
-    public:
-        /*! \brief
-         * Creates a command-line help module.
-         *
-         * \param[in] programContext Information about the running binary.
-         * \param[in] binaryName     Name of the running binary
-         *     (without Gromacs binary suffix or .exe on Windows).
-         * \param[in] modules  List of modules for to use for module listings.
-         * \param[in] groups   List of module groups.
-         * \throws    std::bad_alloc if out of memory.
-         */
-        CommandLineHelpModule(const IProgramContext            &programContext,
-                              const std::string                &binaryName,
-                              const CommandLineModuleMap       &modules,
-                              const CommandLineModuleGroupList &groups);
-        ~CommandLineHelpModule() override;
+public:
+    /*! \brief
+     * Creates a command-line help module.
+     *
+     * \param[in] programContext Information about the running binary.
+     * \param[in] binaryName     Name of the running binary
+     *     (without Gromacs binary suffix or .exe on Windows).
+     * \param[in] modules  List of modules for to use for module listings.
+     * \param[in] groups   List of module groups.
+     * \throws    std::bad_alloc if out of memory.
+     */
+    CommandLineHelpModule(const IProgramContext&            programContext,
+                          const std::string&                binaryName,
+                          const CommandLineModuleMap&       modules,
+                          const CommandLineModuleGroupList& groups);
+    ~CommandLineHelpModule() override;
 
-        /*! \brief
-         * Creates a help topic for a command-line module.
-         *
-         * \param[in] module  Module the create the help topic for.
-         * \throws    std::bad_alloc if out of memory.
-         *
-         * The caller should add the topic using addTopic() if that is desired.
-         * This method is provided separately to allow for strong exception
-         * safety in CommandLineModuleManager::addModule().
-         */
-        HelpTopicPointer
-        createModuleHelpTopic(const ICommandLineModule &module) const;
-        /*! \brief
-         * Adds a top-level help topic.
-         *
-         * \param[in] topic     Help topic to add.
-         * \param[in] bExported Whether this topic will be directly exported to
-         *     the user guide.
-         * \throws    std::bad_alloc if out of memory.
-         */
-        void addTopic(HelpTopicPointer topic, bool bExported);
-        //! Sets whether hidden options will be shown in help.
-        void setShowHidden(bool bHidden);
-        /*! \brief
-         * Sets an override to show the help for the given module.
-         *
-         * If called, the help module directly prints the help for the given
-         * module when called, skipping any other processing.
-         */
-        void setModuleOverride(const ICommandLineModule &module);
+    /*! \brief
+     * Creates a help topic for a command-line module.
+     *
+     * \param[in] module  Module the create the help topic for.
+     * \throws    std::bad_alloc if out of memory.
+     *
+     * The caller should add the topic using addTopic() if that is desired.
+     * This method is provided separately to allow for strong exception
+     * safety in CommandLineModuleManager::addModule().
+     */
+    HelpTopicPointer createModuleHelpTopic(const ICommandLineModule& module) const;
+    /*! \brief
+     * Adds a top-level help topic.
+     *
+     * \param[in] topic     Help topic to add.
+     * \param[in] bExported Whether this topic will be directly exported to
+     *     the user guide.
+     * \throws    std::bad_alloc if out of memory.
+     */
+    void addTopic(HelpTopicPointer topic, bool bExported);
+    //! Sets whether hidden options will be shown in help.
+    void setShowHidden(bool bHidden);
+    /*! \brief
+     * Sets an override to show the help for the given module.
+     *
+     * If called, the help module directly prints the help for the given
+     * module when called, skipping any other processing.
+     */
+    void setModuleOverride(const ICommandLineModule& module);
 
-        /*! \brief
-         * Sets a file redirector for writing help output.
-         *
-         * Used for unit testing; see
-         * CommandLineModuleManager::setOutputRedirector() for more details.
-         */
-        void setOutputRedirector(IFileOutputRedirector *output);
+    /*! \brief
+     * Sets a file redirector for writing help output.
+     *
+     * Used for unit testing; see
+     * CommandLineModuleManager::setOutputRedirector() for more details.
+     */
+    void setOutputRedirector(IFileOutputRedirector* output);
 
-        const char *name() const override { return "help"; }
-        const char *shortDescription() const override
-        {
-            return "Print help information";
-        }
+    const char* name() const override { return "help"; }
+    const char* shortDescription() const override { return "Print help information"; }
 
-        void init(CommandLineModuleSettings *settings) override
-        {
-            settings->setDefaultNiceLevel(0);
-        }
-        int run(int argc, char *argv[]) override;
-        void writeHelp(const CommandLineHelpContext &context) const override;
+    void init(CommandLineModuleSettings* settings) override { settings->setDefaultNiceLevel(0); }
+    int  run(int argc, char* argv[]) override;
+    void writeHelp(const CommandLineHelpContext& context) const override;
 
-    private:
-        typedef CommandLineHelpModuleImpl Impl;
+private:
+    typedef CommandLineHelpModuleImpl Impl;
 
-        PrivateImplPointer<Impl> impl_;
+    PrivateImplPointer<Impl> impl_;
 };
 
 } // namespace gmx