Apply clang-format to source tree

[alexxy/gromacs.git] / src / gromacs / utility / directoryenumerator.h

diff --git a/src/gromacs/utility/directoryenumerator.h b/src/gromacs/utility/directoryenumerator.h
index bb4a05006f46938ec452e143828241128bdde12d..18bf7919822b466d7e8562645dd0308736b6718a 100644 (file)
--- a/src/gromacs/utility/directoryenumerator.h
+++ b/src/gromacs/utility/directoryenumerator.h
@@ -1,7 +1,7 @@
 /*
  * This file is part of the GROMACS molecular simulation package.
  *
- * Copyright (c) 2015,2016, by the GROMACS development team, led by
+ * Copyright (c) 2015,2016,2019, by the GROMACS development team, led by
  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
  * and including many others, as listed in the AUTHORS file in the
  * top-level source directory and at http://www.gromacs.org.
@@ -63,66 +63,67 @@ namespace gmx
  */
 class DirectoryEnumerator
 {
-    public:
-        /*! \brief
-         * Convenience function to list files with certain extension from a
-         * directory.
-         *
-         * \param[in]  dirname   Path to the directory to list.
-         * \param[in]  extension List files with the given extension
-         *     (or suffix in file name).
-         * \param[in]  bThrow    Whether failure to open the directory should throw.
-         * \returns    List of files with the given extension in \p dirname.
-         * \throws std::bad_alloc if out of memory.
-         * \throws FileIOError if opening the directory fails and `bThrow == true`.
-         * \throws FileIOError if some other I/O error occurs.
-         */
-        static std::vector<std::string> enumerateFilesWithExtension(
-            const char *dirname, const char *extension, bool bThrow);
+public:
+    /*! \brief
+     * Convenience function to list files with certain extension from a
+     * directory.
+     *
+     * \param[in]  dirname   Path to the directory to list.
+     * \param[in]  extension List files with the given extension
+     *     (or suffix in file name).
+     * \param[in]  bThrow    Whether failure to open the directory should throw.
+     * \returns    List of files with the given extension in \p dirname.
+     * \throws std::bad_alloc if out of memory.
+     * \throws FileIOError if opening the directory fails and `bThrow == true`.
+     * \throws FileIOError if some other I/O error occurs.
+     */
+    static std::vector<std::string> enumerateFilesWithExtension(const char* dirname,
+                                                                const char* extension,
+                                                                bool        bThrow);
 
-        /*! \brief
-         * Opens a directory for listing.
-         *
-         * \param[in] dirname Path to the directory to list.
-         * \param[in] bThrow  Whether failure to open the directory should throw.
-         * \throws std::bad_alloc if out of memory.
-         * \throws FileIOError if opening the directory fails and `bThrow == true`
-         */
-        explicit DirectoryEnumerator(const char *dirname, bool bThrow = true);
-        //! \copydoc DirectoryEnumerator(const char *, bool)
-        explicit DirectoryEnumerator(const std::string &dirname, bool bThrow = true);
-        ~DirectoryEnumerator();
+    /*! \brief
+     * Opens a directory for listing.
+     *
+     * \param[in] dirname Path to the directory to list.
+     * \param[in] bThrow  Whether failure to open the directory should throw.
+     * \throws std::bad_alloc if out of memory.
+     * \throws FileIOError if opening the directory fails and `bThrow == true`
+     */
+    explicit DirectoryEnumerator(const char* dirname, bool bThrow = true);
+    //! \copydoc DirectoryEnumerator(const char *, bool)
+    explicit DirectoryEnumerator(const std::string& dirname, bool bThrow = true);
+    ~DirectoryEnumerator();
 
-        /*! \brief
-         * Gets next file in a directory.
-         *
-         * \param[out] filename  Name of the next file.
-         * \returns `false` if there were no more files.
-         * \throws  std::bad_alloc if out of memory.
-         * \throws  FileIOError if listing the next file fails.
-         *
-         * If all files from the directory have been returned (or there are no
-         * files in the directory and this is the first call), the method
-         * returns `false` and \p filename is cleared.
-         * Otherwise, the return value is `true` and the first/next file name
-         * is returned in \p filename.
-         * \p filename will not contain any path information, only the name of
-         * the file.
-         *
-         * If `bThrow` passed to the constructor was `false` and the directory
-         * was not successfully opened, the first call to this function will
-         * return `false`.
-         *
-         * This method is not thread safe when called on the same
-         * object by multiple threads. Such use requires external
-         * synchronization.
-         */
-        bool nextFile(std::string *filename);
+    /*! \brief
+     * Gets next file in a directory.
+     *
+     * \param[out] filename  Name of the next file.
+     * \returns `false` if there were no more files.
+     * \throws  std::bad_alloc if out of memory.
+     * \throws  FileIOError if listing the next file fails.
+     *
+     * If all files from the directory have been returned (or there are no
+     * files in the directory and this is the first call), the method
+     * returns `false` and \p filename is cleared.
+     * Otherwise, the return value is `true` and the first/next file name
+     * is returned in \p filename.
+     * \p filename will not contain any path information, only the name of
+     * the file.
+     *
+     * If `bThrow` passed to the constructor was `false` and the directory
+     * was not successfully opened, the first call to this function will
+     * return `false`.
+     *
+     * This method is not thread safe when called on the same
+     * object by multiple threads. Such use requires external
+     * synchronization.
+     */
+    bool nextFile(std::string* filename);
 
-    private:
-        class Impl;
+private:
+    class Impl;
 
-        PrivateImplPointer<Impl> impl_;
+    PrivateImplPointer<Impl> impl_;
 };
 
 } // namespace gmx