summaryrefslogtreecommitdiff
path: root/src/lib/exceptions.h
diff options
context:
space:
mode:
authorCarl Hetherington <cth@carlh.net>2012-09-24 01:58:56 +0100
committerCarl Hetherington <cth@carlh.net>2012-09-24 01:58:56 +0100
commit3fc9a435a720d8b2abd78c1bdc7b34bc635ad797 (patch)
tree2b666a8aadcdf6d657af02c64f188af6ba2e5789 /src/lib/exceptions.h
parent5c887bc8105d92b4b8e9380e62e655ac6691b439 (diff)
Some doxygen documentation improvements.
Diffstat (limited to 'src/lib/exceptions.h')
-rw-r--r--src/lib/exceptions.h5
1 files changed, 5 insertions, 0 deletions
diff --git a/src/lib/exceptions.h b/src/lib/exceptions.h
index 6b567805b..8ef09875b 100644
--- 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;
};