Some doxygen documentation improvements.

[dcpomatic.git] / src / lib / exceptions.h

diff --git a/src/lib/exceptions.h b/src/lib/exceptions.h
index b66d7baa7593bdab18b60335d7d4d7b54c7afbd3..8ef09875ba89383af42fe35ad2cdd99b08fa574a 100644 (file)
--- a/src/lib/exceptions.h
+++ b/src/lib/exceptions.h
@@ -77,6 +77,9 @@ public:
 class FileError : public StringError
 {
 public:
+       /** @param m Error message.
+        *  @param f Name of the file that this exception concerns.
+        */
        FileError (std::string m, std::string f)
                : StringError (m)
                , _file (f)
@@ -84,11 +87,13 @@ public:
 
        virtual ~FileError () throw () {}
 
+       /** @return name of the file that this exception concerns */
        std::string file () const {
                return _file;
        }
 
 private:
+       /** name of the file that this exception concerns */
        std::string _file;
 };
        
@@ -127,7 +132,7 @@ public:
        /** @param f File that we were trying to read from.
         *  @param e errno value, or 0.
         */
-       ReadFileError (std::string f, int e)
+       ReadFileError (std::string f, int e = 0)
                : FileError ("", f)
        {
                std::stringstream s;