aboutsummaryrefslogtreecommitdiff
path: root/common
diff options
context:
space:
mode:
authorMax Horn2009-10-08 21:28:57 +0000
committerMax Horn2009-10-08 21:28:57 +0000
commit3399c3aeb638ae874557c72b4ab4db016ff152c8 (patch)
treef476b2a87837568da3bcdaf031f4eb61293f5086 /common
parent2ab906bafd7e154bb9e333d7e76fe2a714478efd (diff)
downloadscummvm-rg350-3399c3aeb638ae874557c72b4ab4db016ff152c8.tar.gz
scummvm-rg350-3399c3aeb638ae874557c72b4ab4db016ff152c8.tar.bz2
scummvm-rg350-3399c3aeb638ae874557c72b4ab4db016ff152c8.zip
Change doxygen inline comments from "//!" to "///" as proposed on -devel
svn-id: r44802
Diffstat (limited to 'common')
-rw-r--r--common/error.h26
-rw-r--r--common/iff_container.h4
-rw-r--r--common/rect.h8
-rw-r--r--common/util.h14
4 files changed, 26 insertions, 26 deletions
diff --git a/common/error.h b/common/error.h
index d91ce2971a..30142926ca 100644
--- a/common/error.h
+++ b/common/error.h
@@ -44,26 +44,26 @@ namespace Common {
* kPathInvalid, kPathIsInvalid, kInvalidPathError
*/
enum Error {
- kNoError = 0, //!< No error occured
- kInvalidPathError, //!< Engine initialization: Invalid game path was passed
- kNoGameDataFoundError, //!< Engine initialization: No game data was found in the specified location
- kUnsupportedGameidError, //!< Engine initialization: Gameid not supported by this (Meta)Engine
- kUnsupportedColorMode, //!< Engine initialization: Engine does not support backend's color mode
+ kNoError = 0, ///< No error occured
+ kInvalidPathError, ///< Engine initialization: Invalid game path was passed
+ kNoGameDataFoundError, ///< Engine initialization: No game data was found in the specified location
+ kUnsupportedGameidError, ///< Engine initialization: Gameid not supported by this (Meta)Engine
+ kUnsupportedColorMode, ///< Engine initialization: Engine does not support backend's color mode
- kReadPermissionDenied, //!< Unable to read data due to missing read permission
- kWritePermissionDenied, //!< Unable to write data due to missing write permission
+ kReadPermissionDenied, ///< Unable to read data due to missing read permission
+ kWritePermissionDenied, ///< Unable to write data due to missing write permission
// The following three overlap a bit with kInvalidPathError and each other. Which to keep?
- kPathDoesNotExist, //!< The specified path does not exist
- kPathNotDirectory, //!< The specified path does not point to a directory
- kPathNotFile, //!< The specified path does not point to a file
+ kPathDoesNotExist, ///< The specified path does not exist
+ kPathNotDirectory, ///< The specified path does not point to a directory
+ kPathNotFile, ///< The specified path does not point to a file
kCreatingFileFailed,
- kReadingFailed, //!< Failed creating a (savestate) file
- kWritingFailed, //!< Failure to write data -- disk full?
+ kReadingFailed, ///< Failed creating a (savestate) file
+ kWritingFailed, ///< Failure to write data -- disk full?
- kUnknownError //!< Catch-all error, used if no other error code matches
+ kUnknownError ///< Catch-all error, used if no other error code matches
};
} // End of namespace Common
diff --git a/common/iff_container.h b/common/iff_container.h
index ebcf9ba803..0e330a574d 100644
--- a/common/iff_container.h
+++ b/common/iff_container.h
@@ -217,8 +217,8 @@ class IFFParser {
};
protected:
- IFFChunkNav _formChunk; //!< The root chunk of the file.
- IFFChunkNav _chunk; //!< The current chunk.
+ IFFChunkNav _formChunk; ///< The root chunk of the file.
+ IFFChunkNav _chunk; ///< The current chunk.
uint32 _formSize;
Common::IFF_ID _formType;
diff --git a/common/rect.h b/common/rect.h
index 18cc4e56c3..5421cbf3f3 100644
--- a/common/rect.h
+++ b/common/rect.h
@@ -36,8 +36,8 @@ namespace Common {
* Simple class for handling both 2D position and size.
*/
struct Point {
- int16 x; //!< The horizontal part of the point
- int16 y; //!< The vertical part of the point
+ int16 x; ///< The horizontal part of the point
+ int16 y; ///< The vertical part of the point
Point() : x(0), y(0) {}
Point(int16 x1, int16 y1) : x(x1), y(y1) {}
@@ -82,8 +82,8 @@ struct Point {
* When writing code using our Rect class, always keep this principle in mind!
*/
struct Rect {
- int16 top, left; //!< The point at the top left of the rectangle (part of the rect).
- int16 bottom, right; //!< The point at the bottom right of the rectangle (not part of the rect).
+ int16 top, left; ///< The point at the top left of the rectangle (part of the rect).
+ int16 bottom, right; ///< The point at the bottom right of the rectangle (not part of the rect).
Rect() : top(0), left(0), bottom(0), right(0) {}
Rect(int16 w, int16 h) : top(0), left(0), bottom(h), right(w) {}
diff --git a/common/util.h b/common/util.h
index aeadcd1483..8a5f6bbace 100644
--- a/common/util.h
+++ b/common/util.h
@@ -79,15 +79,15 @@ public:
* @note Uses space, horizontal tab, carriage return, newline, form feed and vertical tab as delimiters by default.
*/
StringTokenizer(const String &str, const String &delimiters = " \t\r\n\f\v");
- void reset(); //!< Resets the tokenizer to its initial state
- bool empty() const; //!< Returns true if there are no more tokens left in the string, false otherwise
- String nextToken(); //!< Returns the next token from the string (Or an empty string if there are no more tokens)
+ void reset(); ///< Resets the tokenizer to its initial state
+ bool empty() const; ///< Returns true if there are no more tokens left in the string, false otherwise
+ String nextToken(); ///< Returns the next token from the string (Or an empty string if there are no more tokens)
private:
- const String _str; //!< The string to be tokenized
- const String _delimiters; //!< String containing all the delimiter characters
- uint _tokenBegin; //!< Latest found token's begin (Valid after a call to nextToken(), zero otherwise)
- uint _tokenEnd; //!< Latest found token's end (Valid after a call to nextToken(), zero otherwise)
+ const String _str; ///< The string to be tokenized
+ const String _delimiters; ///< String containing all the delimiter characters
+ uint _tokenBegin; ///< Latest found token's begin (Valid after a call to nextToken(), zero otherwise)
+ uint _tokenEnd; ///< Latest found token's end (Valid after a call to nextToken(), zero otherwise)
};
/**