Update documentation of core/filesystem

engine/core/filesystem/BinaryWriter.h

@@ -32,6 +32,8 @@ namespace crown
 class File;
 
 /// A writer that offers a convenient way to write to a File
+///
+/// @ingroup Filesystem
 class BinaryWriter
 {
 public:

engine/core/filesystem/DiskFile.h

@@ -34,6 +34,8 @@ namespace crown
 {
 
 /// Provides common facilities to access files on disk.
+///
+/// @ingroup Filesystem
 class DiskFile: public File
 {
 public:

engine/core/filesystem/DiskFilesystem.h

@@ -38,6 +38,8 @@ namespace crown
 /// to its absolute counterpart based on the file source's root path.
 /// Accessing files using absolute path directly is also possible,
 /// but platform-specific and thus generally not recommended.
+///
+/// @ingroup Filesystem
 class CE_EXPORT  DiskFilesystem : public Filesystem
 {
 public:

engine/core/filesystem/File.h

@@ -46,6 +46,8 @@ class Compressor;
 /// A File is an abstraction to interact with these in an uniform way; every file
 /// comes with a convenient set of methods to facilitate reading from it, writing to
 /// it and so on.
+///
+/// @ingroup Filesystem
 class File
 {
 public:

engine/core/filesystem/Filesystem.h

@@ -33,6 +33,8 @@ OTHER DEALINGS IN THE SOFTWARE.
 namespace crown
 {
 
+/// @defgroup Filesystem Filesystem
+
 /// Provides a platform-independent way to access files and directories
 /// on the host filesystem.
 ///
@@ -78,6 +80,8 @@ namespace crown
 /// 1) data/textures/grass.texture
 /// 2) grass.texture
 /// 3) foo/bar
+///
+/// @ingroup Filesystem
 class Filesystem
 {
 public:
@@ -86,31 +90,31 @@ public:
 	virtual				~Filesystem() {};
 
 	/// Opens the file at the given @a path with the given @a mode.
-	virtual File*		open(const char* path, FileOpenMode mode) = 0;
+	virtual File* open(const char* path, FileOpenMode mode) = 0;
 
 	/// Closes the given @a file.
-	virtual void		close(File* file) = 0;
+	virtual void close(File* file) = 0;
 
 	/// Returns true if @a path is a directory.
-	virtual bool		is_directory(const char* path) = 0;
+	virtual bool is_directory(const char* path) = 0;
 
 	/// Returns true if @a path is a regular file.
-	virtual bool		is_file(const char* path) = 0;
+	virtual bool is_file(const char* path) = 0;
 
 	/// Creates the directory at the given @a path.
-	virtual void		create_directory(const char* path) = 0;
+	virtual void create_directory(const char* path) = 0;
 
 	/// Deletes the directory at the given @a path.
-	virtual void		delete_directory(const char* path) = 0;
+	virtual void delete_directory(const char* path) = 0;
 
 	/// Creates the file at the given @a path.
-	virtual void		create_file(const char* path) = 0;
+	virtual void create_file(const char* path) = 0;
 
 	/// Deletes the file at the given @a path.
-	virtual void		delete_file(const char* path) = 0;
+	virtual void delete_file(const char* path) = 0;
 
 	/// Returns the relative file names in the given @a path.
-	virtual void		list_files(const char* path, Vector<DynamicString>& files) = 0;
+	virtual void list_files(const char* path, Vector<DynamicString>& files) = 0;
 
 	/// Returns the absolute path of the given @a path based on
 	/// the root path of the file source. If @a path is absolute,
@@ -120,8 +124,8 @@ public:
 private:
 
 	// Disable copying
-						Filesystem(const Filesystem&);
-	Filesystem&			operator=(const Filesystem&);
+	Filesystem(const Filesystem&);
+	Filesystem& operator=(const Filesystem&);
 };
 
 } // namespace crown

engine/core/filesystem/NetworkFile.h

@@ -35,6 +35,8 @@ namespace crown
 {
 
 /// Access file on a remote file server.
+///
+/// @ingroup Filesystem
 class NetworkFile: public File
 {
 public:

engine/core/filesystem/NetworkFilesystem.h

@@ -62,6 +62,8 @@ namespace network_filesystem
 /// to its absolute counterpart based on the file server's root path.
 /// Accessing files using absolute path directly is also possible,
 /// but platform-specific and thus generally not recommended.
+///
+/// @ingroup Filesystem
 class NetworkFilesystem : public Filesystem
 {
 public:

engine/core/filesystem/NullFile.h

@@ -34,6 +34,8 @@ namespace crown
 
 /// Bit bucket file.
 /// Discards all data written to it and provides null data reading from it; plain and simple.
+///
+/// @ingroup Filesystem
 class NullFile: public File
 {
 public:

engine/core/filesystem/TextReader.h

@@ -32,6 +32,8 @@ namespace crown
 class File;
 
 /// A reader that offers a convenient way to read text from a File
+///
+/// @ingroup Filesystem
 class TextReader
 {
 public:

engine/core/filesystem/TextWriter.h

@@ -30,6 +30,8 @@ namespace crown
 class File;
 
 /// A reader that offers a convenient way to write text to a File
+///
+/// @ingroup Filesystem
 class TextWriter
 {
 public: