Browse Source

Fix doxygen documentation tags

Daniele Bartolini 12 years ago
parent
commit
ef9cf1abb0
53 changed files with 255 additions and 255 deletions
  1. 1 1
      game/Game.h
  2. 2 2
      src/ArchiveBundle.h
  3. 1 1
      src/Bundle.h
  4. 8 8
      src/Camera.h
  5. 3 3
      src/Config.h.in
  6. 2 2
      src/FileBundle.h
  7. 9 9
      src/ResourceManager.h
  8. 3 3
      src/core/Args.h
  9. 6 6
      src/core/bv/Box.h
  10. 1 1
      src/core/bv/Circle.h
  11. 2 2
      src/core/bv/Frustum.h
  12. 5 5
      src/core/bv/Rect.h
  13. 4 4
      src/core/bv/Sphere.h
  14. 4 4
      src/core/compressors/Compressor.h
  15. 2 2
      src/core/compressors/ZipCompressor.h
  16. 3 3
      src/core/containers/IdTable.h
  17. 5 5
      src/core/containers/List.h
  18. 5 5
      src/core/containers/Queue.h
  19. 15 15
      src/core/filesystem/DiskFile.h
  20. 1 1
      src/core/filesystem/File.h
  21. 13 13
      src/core/filesystem/Filesystem.h
  22. 16 16
      src/core/filesystem/MemoryFile.h
  23. 16 16
      src/core/filesystem/NullFile.h
  24. 3 3
      src/core/math/Interpolation.h
  25. 6 6
      src/core/math/Mat3.h
  26. 6 6
      src/core/math/Mat4.h
  27. 22 22
      src/core/math/MathUtils.h
  28. 2 2
      src/core/math/Plane.h
  29. 1 1
      src/core/math/Quat.h
  30. 1 1
      src/core/math/Random.h
  31. 1 1
      src/core/math/Ray.h
  32. 2 2
      src/core/math/Triangle.h
  33. 2 2
      src/core/math/Vec2.h
  34. 2 2
      src/core/math/Vec4.h
  35. 4 4
      src/core/mem/Allocator.h
  36. 4 4
      src/core/mem/MallocAllocator.h
  37. 1 1
      src/core/mem/Memory.h
  38. 3 3
      src/core/mem/ProxyAllocator.h
  39. 6 6
      src/core/strings/Path.h
  40. 3 3
      src/input/Keyboard.h
  41. 2 2
      src/input/Mouse.h
  42. 4 4
      src/input/Touch.h
  43. 1 1
      src/network/BitMessage.h
  44. 1 1
      src/os/OS.h
  45. 5 5
      src/os/android/OsFile.h
  46. 5 5
      src/os/posix/OsFile.h
  47. 1 1
      src/os/win/WinKeyboard.cpp
  48. 7 7
      src/os/win/WinKeyboard.h
  49. 9 9
      src/os/win/WinMouse.h
  50. 2 2
      src/renderers/PixelFormat.h
  51. 13 13
      src/renderers/Renderer.h
  52. 2 2
      src/renderers/VertexFormat.h
  53. 7 7
      tools/editors/world-editor/terrain/Heightfield.h

+ 1 - 1
game/Game.h

@@ -42,7 +42,7 @@ extern "C"
 	void shutdown();
 	void shutdown();
 
 
 	/// Called once per frame, here is the place you tipically perform input checking,
 	/// Called once per frame, here is the place you tipically perform input checking,
-	/// updates, drawing and so on. The @dt parameter contains the last frame delta time
+	/// updates, drawing and so on. The @a dt parameter contains the last frame delta time
 	/// in seconds. 
 	/// in seconds. 
 	void frame(float dt);
 	void frame(float dt);
 }
 }

+ 2 - 2
src/ArchiveBundle.h

@@ -62,10 +62,10 @@ public:
 					ArchiveBundle(Filesystem& fs);
 					ArchiveBundle(Filesystem& fs);
 					~ArchiveBundle();
 					~ArchiveBundle();
 
 
-	/// @copydoc Bundle::open()
+	/// @a copydoc Bundle::open()
 	DiskFile*		open(ResourceId name);
 	DiskFile*		open(ResourceId name);
 
 
-	/// @copydoc Bundle::close()
+	/// @a copydoc Bundle::close()
 	void			close(DiskFile* resource);
 	void			close(DiskFile* resource);
 
 
 private:
 private:

+ 1 - 1
src/Bundle.h

@@ -57,7 +57,7 @@ public:
 
 
 	virtual					~Bundle() {}
 	virtual					~Bundle() {}
 
 
-	/// Opens the resource file containing @name resource
+	/// Opens the resource file containing @a name resource
 	/// and returns a stream from which read the data from.
 	/// and returns a stream from which read the data from.
 	/// @note
 	/// @note
 	/// The resource stream points exactly at the start
 	/// The resource stream points exactly at the start

+ 8 - 8
src/Camera.h

@@ -39,14 +39,14 @@ class Camera
 {
 {
 public:
 public:
 
 
-	/// Construct the camera placed at the given world-space @position
-	/// with the given @fov field of view and @aspect ratio.
+	/// Construct the camera placed at the given world-space @a position
+	/// with the given @a fov field of view and @a aspect ratio.
 					Camera(const Vec3& position, float fov, float aspect);
 					Camera(const Vec3& position, float fov, float aspect);
 
 
 	/// Returns the world-space position of the camera 
 	/// Returns the world-space position of the camera 
 	const Vec3&		position() const;
 	const Vec3&		position() const;
 
 
-	/// Sets the world-space @position of the camera
+	/// Sets the world-space @a position of the camera
 	void			set_position(const Vec3& position);
 	void			set_position(const Vec3& position);
 
 
 	/// Returns the lookat-point of the camera
 	/// Returns the lookat-point of the camera
@@ -55,7 +55,7 @@ public:
 	/// Sets the lookat-point of the camera
 	/// Sets the lookat-point of the camera
 	void			set_look_at(const Vec3& lookat);
 	void			set_look_at(const Vec3& lookat);
 
 
-	/// Sets the rotation of the camera about the world's @x axis and @y axis
+	/// Sets the rotation of the camera about the world's @a x axis and @a y axis
 	void			set_rotation(const float x, const float y);
 	void			set_rotation(const float x, const float y);
 
 
 	/// Returns the up-vector of the camera
 	/// Returns the up-vector of the camera
@@ -94,16 +94,16 @@ public:
 	/// Returns the renderer-independent view matrix used by the camera
 	/// Returns the renderer-independent view matrix used by the camera
 	const Mat4&		view_matrix() const;
 	const Mat4&		view_matrix() const;
 
 
-	/// Moves the camera towards look direction by @meters meters
+	/// Moves the camera towards look direction by @a meters meters
 	void			move_forward(float meters);
 	void			move_forward(float meters);
 
 
-	/// Moves the camera towards the opposite look direction by @meters meters
+	/// Moves the camera towards the opposite look direction by @a meters meters
 	void			move_backward(float meters);
 	void			move_backward(float meters);
 
 
-	/// Moves the camera along the axis perpendicular to the look direction by @meters meters
+	/// Moves the camera along the axis perpendicular to the look direction by @a meters meters
 	void			strafe_left(float meters);
 	void			strafe_left(float meters);
 
 
-	/// Moves the camera along the axis perpendicular to the look direction by @meters meters
+	/// Moves the camera along the axis perpendicular to the look direction by @a meters meters
 	void			strafe_right(float meters);
 	void			strafe_right(float meters);
 
 
 protected:
 protected:

+ 3 - 3
src/Config.h.in

@@ -24,9 +24,9 @@ FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 OTHER DEALINGS IN THE SOFTWARE.
 OTHER DEALINGS IN THE SOFTWARE.
 */
 */
 
 
-#define CROWN_VERSION_MAJOR @CROWN_VERSION_MAJOR@
-#define CROWN_VERSION_MINOR @CROWN_VERSION_MINOR@
-#define CROWN_VERSION_MICRO @CROWN_VERSION_MICRO@
+#define CROWN_VERSION_MAJOR @a CROWN_VERSION_MAJOR@a 
+#define CROWN_VERSION_MINOR @a CROWN_VERSION_MINOR@a 
+#define CROWN_VERSION_MICRO @a CROWN_VERSION_MICRO@a 
 
 
 #cmakedefine LINUX
 #cmakedefine LINUX
 #cmakedefine WINDOWS
 #cmakedefine WINDOWS

+ 2 - 2
src/FileBundle.h

@@ -53,10 +53,10 @@ public:
 					FileBundle(Filesystem& fs);
 					FileBundle(Filesystem& fs);
 					~FileBundle();
 					~FileBundle();
 
 
-	/// @copydoc Bundle::open()
+	/// @a copydoc Bundle::open()
 	DiskFile*		open(ResourceId name);
 	DiskFile*		open(ResourceId name);
 
 
-	/// @copydoc Bundle::close()
+	/// @a copydoc Bundle::close()
 	void			close(DiskFile* resource);
 	void			close(DiskFile* resource);
 
 
 
 

+ 9 - 9
src/ResourceManager.h

@@ -70,11 +70,11 @@ class ResourceManager
 {
 {
 public:
 public:
 
 
-	/// Read resources from @bundle and store resource data using @allocator.
+	/// Read resources from @a bundle and store resource data using @a allocator.
 							ResourceManager(Bundle& bundle);
 							ResourceManager(Bundle& bundle);
 							~ResourceManager();
 							~ResourceManager();
 
 
-	/// Loads the resource by @name and returns its ResourceId.
+	/// Loads the resource by @a name and returns its ResourceId.
 	/// @note
 	/// @note
 	/// The resource data may be not immediately available,
 	/// The resource data may be not immediately available,
 	/// the resource gets pushed in a queue of load requests and loadead as
 	/// the resource gets pushed in a queue of load requests and loadead as
@@ -83,15 +83,15 @@ public:
 	/// loading process is actually completed.
 	/// loading process is actually completed.
 	ResourceId				load(const char* name);
 	ResourceId				load(const char* name);
 
 
-	/// Unloads the @resource, freeing up all the memory associated by it
+	/// Unloads the @a resource, freeing up all the memory associated by it
 	/// and eventually any global object associated with it.
 	/// and eventually any global object associated with it.
 	/// (Such as texture objects, vertex buffers etc.)
 	/// (Such as texture objects, vertex buffers etc.)
 	void					unload(ResourceId name);
 	void					unload(ResourceId name);
 
 
-	/// Reloads the @resource
+	/// Reloads the @a resource
 	void					reload(ResourceId name);
 	void					reload(ResourceId name);
 
 
-	/// Returns whether the manager has the @name resource into
+	/// Returns whether the manager has the @a name resource into
 	/// its list of resources.
 	/// its list of resources.
 	/// @note
 	/// @note
 	/// Having a resource does not mean that the resource is
 	/// Having a resource does not mean that the resource is
@@ -99,18 +99,18 @@ public:
 	/// obtain the resource availability status.
 	/// obtain the resource availability status.
 	bool					has(ResourceId name) const;
 	bool					has(ResourceId name) const;
 
 
-	/// Returns the data associated with the @name resource.
+	/// Returns the data associated with the @a name resource.
 	/// The resource data contains resource-specific metadata
 	/// The resource data contains resource-specific metadata
 	/// and the actual resource data. In order to correctly use
 	/// and the actual resource data. In order to correctly use
-	/// it, you have to know which type of data @name refers to
+	/// it, you have to know which type of data @a name refers to
 	/// and cast accordingly.
 	/// and cast accordingly.
 	const void*				data(ResourceId name) const;
 	const void*				data(ResourceId name) const;
 	
 	
-	/// Returns whether the @name resource is loaded (i.e. whether
+	/// Returns whether the @a name resource is loaded (i.e. whether
 	/// you can use the data associated with it).
 	/// you can use the data associated with it).
 	bool					is_loaded(ResourceId name) const;
 	bool					is_loaded(ResourceId name) const;
 
 
-	/// Returns the number of references to the @resource
+	/// Returns the number of references to the @a resource
 	uint32_t				references(ResourceId name) const;
 	uint32_t				references(ResourceId name) const;
 
 
 	/// Returns the number of resources still waiting to load.
 	/// Returns the number of resources still waiting to load.

+ 3 - 3
src/core/Args.h

@@ -77,13 +77,13 @@ public:
 	const char*			optarg() const;
 	const char*			optarg() const;
 
 
 
 
-	/// Sets the @index into argv[] from where to start option scanning.
-	/// If @index >= argc nothing will be scanned.
+	/// Sets the @a index into argv[] from where to start option scanning.
+	/// If @a index >= argc nothing will be scanned.
 	void				set_optind(int32_t index);
 	void				set_optind(int32_t index);
 
 
 private:
 private:
 
 
-	// Returns the @option type
+	// Returns the @a option type
 	// Returns AOT_SHORT if option is of the form "-x" where 'x' is the option.
 	// Returns AOT_SHORT if option is of the form "-x" where 'x' is the option.
 	// Returns AOT_LONG if option is of the form "--option" where "option" is the option.
 	// Returns AOT_LONG if option is of the form "--option" where "option" is the option.
 	// Returns AOT_NOT_OPTION in all other cases.
 	// Returns AOT_NOT_OPTION in all other cases.

+ 6 - 6
src/core/bv/Box.h

@@ -44,7 +44,7 @@ public:
 	/// Does nothing for efficiency.
 	/// Does nothing for efficiency.
 					Box();
 					Box();
 
 
-	/// Constructs from @min and @max.
+	/// Constructs from @a min and @a max.
 					Box(const Vec3& min, const Vec3& max);			
 					Box(const Vec3& min, const Vec3& max);			
 					Box(const Box& box);
 					Box(const Box& box);
 
 
@@ -57,19 +57,19 @@ public:
 	real			radius() const;
 	real			radius() const;
 	real			volume() const;
 	real			volume() const;
 
 
-	/// Adds @count @points expanding if necessary.
+	/// Adds @a count @a points expanding if necessary.
 	void			add_points(const Vec3* points, uint32_t count);
 	void			add_points(const Vec3* points, uint32_t count);
 
 
-	/// Adds @count @boxes expanding if necessay.
+	/// Adds @a count @a boxes expanding if necessay.
 	void			add_boxes(const Box* boxes, uint32_t count);
 	void			add_boxes(const Box* boxes, uint32_t count);
 
 
-	/// Returns whether point @p is contained in the box.
+	/// Returns whether point @a p is contained in the box.
 	bool			contains_point(const Vec3& p) const;
 	bool			contains_point(const Vec3& p) const;
 
 
-	/// Returns the @index -th vertex of the box.
+	/// Returns the @a index -th vertex of the box.
 	Vec3			vertex(uint32_t index) const;		
 	Vec3			vertex(uint32_t index) const;		
 
 
-	/// Returns the box trasformed according to @mat matrix into @result.
+	/// Returns the box trasformed according to @a mat matrix into @a result.
 	void			transformed(const Mat4& mat, Box& result) const;	
 	void			transformed(const Mat4& mat, Box& result) const;	
 
 
 	/// Returns the eight vertices of the box.
 	/// Returns the eight vertices of the box.

+ 1 - 1
src/core/bv/Circle.h

@@ -44,7 +44,7 @@ public:
 	/// Does nothing for efficiency.
 	/// Does nothing for efficiency.
 					Circle();
 					Circle();
 					
 					
-	/// Constructs from @center and @radius.
+	/// Constructs from @a center and @a radius.
 					Circle(const Vec2& center, real radius);	
 					Circle(const Vec2& center, real radius);	
 					Circle(const Circle& circle);				
 					Circle(const Circle& circle);				
 
 

+ 2 - 2
src/core/bv/Frustum.h

@@ -53,13 +53,13 @@ public:
 				Frustum();				
 				Frustum();				
 				Frustum(const Frustum& frustum);
 				Frustum(const Frustum& frustum);
 
 
-	/// Returns whether @point is contained into the frustum.
+	/// Returns whether @a point is contained into the frustum.
 	bool		contains_point(const Vec3& point) const;	
 	bool		contains_point(const Vec3& point) const;	
 
 
 	/// Returns one of the eight frustum's corners.
 	/// Returns one of the eight frustum's corners.
 	Vec3		vertex(uint32_t index) const;			
 	Vec3		vertex(uint32_t index) const;			
 
 
-	/// Builds the view frustum according to the matrix @m.
+	/// Builds the view frustum according to the matrix @a m.
 	void		from_matrix(const Mat4& m);				
 	void		from_matrix(const Mat4& m);				
 
 
 	/// Returns a Box containing the frustum volume.
 	/// Returns a Box containing the frustum volume.

+ 5 - 5
src/core/bv/Rect.h

@@ -43,7 +43,7 @@ public:
 	/// Does nothing for efficiency.
 	/// Does nothing for efficiency.
 					Rect();		
 					Rect();		
 
 
-	/// Constructs from  @min and @max
+	/// Constructs from  @a min and @a max
 					Rect(const Vec2& min, const Vec2& max);		
 					Rect(const Vec2& min, const Vec2& max);		
 					Rect(const Rect& rect);	
 					Rect(const Rect& rect);	
 
 
@@ -59,19 +59,19 @@ public:
 	/// Returns the diagonal of the rect.
 	/// Returns the diagonal of the rect.
 	Vec2			size() const;						
 	Vec2			size() const;						
 
 
-	/// Returns whether @point point is contained into the rect.
+	/// Returns whether @a point point is contained into the rect.
 	bool			contains_point(const Vec2& point) const;
 	bool			contains_point(const Vec2& point) const;
 
 
-	/// Returns whether the rect intersects @r.
+	/// Returns whether the rect intersects @a r.
 	bool			intersects_rect(const Rect& rect) const;	
 	bool			intersects_rect(const Rect& rect) const;	
 
 
-	/// Sets the Rect from a @center and a @width - @height
+	/// Sets the Rect from a @a center and a @a width - @a height
 	void			set_from_center_and_dimensions(Vec2 center, real width, real height);	
 	void			set_from_center_and_dimensions(Vec2 center, real width, real height);	
 
 
 	/// Returns the four vertices of the rect.
 	/// Returns the four vertices of the rect.
 	void			vertices(Vec2 v[4]) const;
 	void			vertices(Vec2 v[4]) const;
 
 
-	/// Returns the @index -th vetex of the rect.
+	/// Returns the @a index -th vetex of the rect.
 	Vec2			vertex(uint32_t index) const;			
 	Vec2			vertex(uint32_t index) const;			
 
 
 	/// Returns the equivalent circle.
 	/// Returns the equivalent circle.

+ 4 - 4
src/core/bv/Sphere.h

@@ -43,7 +43,7 @@ public:
 	/// Does nothing for efficiency.
 	/// Does nothing for efficiency.
 					Sphere();
 					Sphere();
 
 
-	/// Constructs from @center and @radius.
+	/// Constructs from @a center and @a radius.
 					Sphere(const Vec3& center, real radius);
 					Sphere(const Vec3& center, real radius);
 					Sphere(const Sphere& a);
 					Sphere(const Sphere& a);
 
 
@@ -54,13 +54,13 @@ public:
 	void			set_center(const Vec3& center);
 	void			set_center(const Vec3& center);
 	void			set_radius(real radius);
 	void			set_radius(real radius);
 
 
-	/// Adds @count @points to the sphere expanding if necessary.
+	/// Adds @a count @a points to the sphere expanding if necessary.
 	void			add_points(const Vec3* points, uint32_t count);	
 	void			add_points(const Vec3* points, uint32_t count);	
 
 
-	/// Adds @count @spheres expanding if necessary.
+	/// Adds @a count @a spheres expanding if necessary.
 	void			add_spheres(const Sphere* spheres, uint32_t count);	
 	void			add_spheres(const Sphere* spheres, uint32_t count);	
 
 
-	/// Returns whether point @p is contained into the sphere.
+	/// Returns whether point @a p is contained into the sphere.
 	bool			contains_point(const Vec3& p) const;		
 	bool			contains_point(const Vec3& p) const;		
 
 
 private:
 private:

+ 4 - 4
src/core/compressors/Compressor.h

@@ -37,14 +37,14 @@ public:
 						Compressor(Allocator& allocator);
 						Compressor(Allocator& allocator);
 	virtual 			~Compressor() {}
 	virtual 			~Compressor() {}
 
 
-	/// Compresses the data pointed by @data of size @in_size (in bytes) and returns it.
-	/// The function also returns the size in bytes of the compressed data in @out_size.
+	/// Compresses the data pointed by @a data of size @a in_size (in bytes) and returns it.
+	/// The function also returns the size in bytes of the compressed data in @a out_size.
 	/// @note
 	/// @note
 	/// The returned data is automatically allocated using the passed allocator.
 	/// The returned data is automatically allocated using the passed allocator.
 	virtual uint8_t* 	compress(const void* data, size_t in_size, size_t& out_size) = 0;
 	virtual uint8_t* 	compress(const void* data, size_t in_size, size_t& out_size) = 0;
 
 
-	/// Uncompresses the data pointed by @data of size @in_size (in bytes) and returns it.
-	/// The function also returns the size in bytes of the uncompressed data in @out_size.
+	/// Uncompresses the data pointed by @a data of size @a in_size (in bytes) and returns it.
+	/// The function also returns the size in bytes of the uncompressed data in @a out_size.
 	/// @note
 	/// @note
 	/// The returned data is automatically allocated using the passed allocator.
 	/// The returned data is automatically allocated using the passed allocator.
 	virtual uint8_t* 	uncompress(const void* data, size_t in_size, size_t& out_size) = 0;
 	virtual uint8_t* 	uncompress(const void* data, size_t in_size, size_t& out_size) = 0;

+ 2 - 2
src/core/compressors/ZipCompressor.h

@@ -38,10 +38,10 @@ public:
 				ZipCompressor(Allocator& allocator);
 				ZipCompressor(Allocator& allocator);
 				~ZipCompressor();
 				~ZipCompressor();
 	
 	
-	/// @copydoc Compressor::compress()
+	/// @a copydoc Compressor::compress()
 	uint8_t* 	compress(const void* data, size_t in_size, size_t& out_size);
 	uint8_t* 	compress(const void* data, size_t in_size, size_t& out_size);
 
 
-	/// @copydoc Compressor::uncompress()
+	/// @a copydoc Compressor::uncompress()
 	uint8_t* 	uncompress(const void* data, size_t in_size, size_t& out_size);
 	uint8_t* 	uncompress(const void* data, size_t in_size, size_t& out_size);
 };
 };
 
 

+ 3 - 3
src/core/containers/IdTable.h

@@ -48,17 +48,17 @@ class IdTable
 {
 {
 public:
 public:
 
 
-	/// Creates the table for tracking exactly @max_ids - 1 unique Ids.
+	/// Creates the table for tracking exactly @a max_ids - 1 unique Ids.
 					IdTable(Allocator& allocator, uint16_t max_ids);
 					IdTable(Allocator& allocator, uint16_t max_ids);
 					~IdTable();
 					~IdTable();
 
 
 	/// Returns a new Id.
 	/// Returns a new Id.
 	Id				create();
 	Id				create();
 
 
-	/// Destroys the specified @id.
+	/// Destroys the specified @a id.
 	void			destroy(Id id);
 	void			destroy(Id id);
 
 
-	/// Returns whether the table has the specified @id
+	/// Returns whether the table has the specified @a id
 	bool			has(Id id) const;
 	bool			has(Id id) const;
 
 
 private:
 private:

+ 5 - 5
src/core/containers/List.h

@@ -64,20 +64,20 @@ public:
 	/// Returns the maximum number of items the array can hold
 	/// Returns the maximum number of items the array can hold
 	uint32_t			capacity() const;
 	uint32_t			capacity() const;
 
 
-	/// Resizes the list to the given @size.
+	/// Resizes the list to the given @a size.
 	/// @note
 	/// @note
 	/// Old items will be copied to the newly created list.
 	/// Old items will be copied to the newly created list.
 	/// If the new capacity is smaller than the previous one, the
 	/// If the new capacity is smaller than the previous one, the
 	/// list will be truncated.
 	/// list will be truncated.
 	void				resize(uint32_t size);
 	void				resize(uint32_t size);
 
 
-	/// Reserves space in the list for at least @capacity items.
+	/// Reserves space in the list for at least @a capacity items.
 	void				reserve(uint32_t capacity);
 	void				reserve(uint32_t capacity);
 
 
 	/// Sets the list capacity
 	/// Sets the list capacity
 	void				set_capacity(uint32_t capacity);
 	void				set_capacity(uint32_t capacity);
 
 
-	/// Grows the list to contain at least @min_capacity items
+	/// Grows the list to contain at least @a min_capacity items
 	void				grow(uint32_t min_capacity);
 	void				grow(uint32_t min_capacity);
 
 
 	/// Condenses the array so that the capacity matches the actual number
 	/// Condenses the array so that the capacity matches the actual number
@@ -90,7 +90,7 @@ public:
 	/// Removes the last item from the list.
 	/// Removes the last item from the list.
 	void				pop_back();
 	void				pop_back();
 
 
-	/// Appends @count @items to the list and returns the number
+	/// Appends @a count @a items to the list and returns the number
 	/// of items in the list after the append operation.
 	/// of items in the list after the append operation.
 	uint32_t			push(const T* items, uint32_t count);
 	uint32_t			push(const T* items, uint32_t count);
 
 
@@ -100,7 +100,7 @@ public:
 	/// the number of items in the list for efficiency.
 	/// the number of items in the list for efficiency.
 	void				clear();
 	void				clear();
 
 
-	/// Copies the content of the @other list into this one.
+	/// Copies the content of the @a other list into this one.
 	const List<T>&		operator=(const List<T>& other);
 	const List<T>&		operator=(const List<T>& other);
 
 
 	T*					begin();
 	T*					begin();

+ 5 - 5
src/core/containers/Queue.h

@@ -64,23 +64,23 @@ public:
 	/// Increase or decrease the capacity of the queue.
 	/// Increase or decrease the capacity of the queue.
 	/// @note
 	/// @note
 	/// Old items will be copied to the newly created queue.
 	/// Old items will be copied to the newly created queue.
-	/// If the new @capacity is smaller than the previous one, the
+	/// If the new @a capacity is smaller than the previous one, the
 	/// queue will be truncated.
 	/// queue will be truncated.
 	void			increase_capacity(uint32_t capacity);
 	void			increase_capacity(uint32_t capacity);
 
 
-	/// Grows the queue to contain at least @min_capacity items.
-	/// If @min_capacity is set to 0, the queue automatically
+	/// Grows the queue to contain at least @a min_capacity items.
+	/// If @a min_capacity is set to 0, the queue automatically
 	/// determines the new capacity based on its size at the 
 	/// determines the new capacity based on its size at the 
 	/// time of call.
 	/// time of call.
 	void			grow(uint32_t min_capacity);
 	void			grow(uint32_t min_capacity);
 
 
-	/// Adds an @item to the back of the queue
+	/// Adds an @a item to the back of the queue
 	void			push_back(const T& item);
 	void			push_back(const T& item);
 
 
 	/// Removes the last item from the queue
 	/// Removes the last item from the queue
 	void			pop_back();
 	void			pop_back();
 
 
-	/// Adds an @item to the front of the queue
+	/// Adds an @a item to the front of the queue
 	void			push_front(const T& item);
 	void			push_front(const T& item);
 
 
 	/// Removes the first item from the queue
 	/// Removes the first item from the queue

+ 15 - 15
src/core/filesystem/DiskFile.h

@@ -37,50 +37,50 @@ class DiskFile: public File
 {
 {
 public:
 public:
 
 
-	/// Opens @filename with specified @mode
+	/// Opens @a filename with specified @a mode
 					DiskFile(FileOpenMode mode, const char* filename);
 					DiskFile(FileOpenMode mode, const char* filename);
 	virtual			~DiskFile();
 	virtual			~DiskFile();
 
 
-	/// @copydoc File::seek() 
+	/// @a copydoc File::seek() 
 	void			seek(size_t position);
 	void			seek(size_t position);
 
 
-	/// @copydoc File::seek_to_end() 
+	/// @a copydoc File::seek_to_end() 
 	void			seek_to_end();
 	void			seek_to_end();
 
 
-	/// @copydoc File::skip() 
+	/// @a copydoc File::skip() 
 	void			skip(size_t bytes);
 	void			skip(size_t bytes);
 
 
-	/// @copydoc File::read() 
+	/// @a copydoc File::read() 
 	void			read(void* buffer, size_t size);
 	void			read(void* buffer, size_t size);
 
 
-	/// @copydoc File::write() 
+	/// @a copydoc File::write() 
 	void			write(const void* buffer, size_t size);
 	void			write(const void* buffer, size_t size);
 
 
-	/// @copydoc File::copy_to() 
+	/// @a copydoc File::copy_to() 
 	bool			copy_to(File& file, size_t size = 0);
 	bool			copy_to(File& file, size_t size = 0);
 
 
-	/// @copydoc File::flush() 
+	/// @a copydoc File::flush() 
 	void			flush();
 	void			flush();
 
 
-	/// @copydoc File::end_of_file() 
+	/// @a copydoc File::end_of_file() 
 	bool			end_of_file() const;
 	bool			end_of_file() const;
 
 
-	/// @copydoc File::is_valid() 
+	/// @a copydoc File::is_valid() 
 	bool			is_valid() const;
 	bool			is_valid() const;
 
 
-	/// @copydoc File::size() 
+	/// @a copydoc File::size() 
 	size_t			size() const;
 	size_t			size() const;
 
 
-	/// @copydoc File::position() 
+	/// @a copydoc File::position() 
 	size_t			position() const;
 	size_t			position() const;
 
 
-	/// @copydoc File::can_read() 
+	/// @a copydoc File::can_read() 
 	bool			can_read() const;
 	bool			can_read() const;
 
 
-	/// @copydoc File::can_write() 
+	/// @a copydoc File::can_write() 
 	bool			can_write() const;
 	bool			can_write() const;
 
 
-	/// @copydoc File::can_seek() 
+	/// @a copydoc File::can_seek() 
 	bool			can_seek() const;
 	bool			can_seek() const;
 
 
 protected:
 protected:

+ 1 - 1
src/core/filesystem/File.h

@@ -49,7 +49,7 @@ class File
 {
 {
 public:
 public:
 
 
-	/// Opens the file with the given @mode
+	/// Opens the file with the given @a mode
 						File(FileOpenMode mode) : m_open_mode(mode) {}
 						File(FileOpenMode mode) : m_open_mode(mode) {}
 	virtual				~File() {};
 	virtual				~File() {};
 
 

+ 13 - 13
src/core/filesystem/Filesystem.h

@@ -101,48 +101,48 @@ class Filesystem
 {
 {
 public:
 public:
 
 
-	/// The @root_path must be absolute.
+	/// The @a root_path must be absolute.
 						Filesystem(const char* root_path);
 						Filesystem(const char* root_path);
 						~Filesystem();
 						~Filesystem();
 
 
 	/// Returns the root path of the filesystem
 	/// Returns the root path of the filesystem
 	const char*			root_path() const;
 	const char*			root_path() const;
 
 
-	/// Returns whether the @relative_path exists and fills @info with
-	/// with informations about the given @relative_path path
+	/// Returns whether the @a relative_path exists and fills @a info with
+	/// with informations about the given @a relative_path path
 	bool				get_info(const char* relative_path, FilesystemEntry& info);
 	bool				get_info(const char* relative_path, FilesystemEntry& info);
 	
 	
-	/// Returns whether the @relative_path exists on disk
+	/// Returns whether the @a relative_path exists on disk
 	bool				exists(const char* relative_path);
 	bool				exists(const char* relative_path);
 
 
-	/// Returns whether @relative_path is a regular file
+	/// Returns whether @a relative_path is a regular file
 	bool				is_file(const char* relative_path);
 	bool				is_file(const char* relative_path);
 
 
-	/// Returns whether @relative_path is a directory
+	/// Returns whether @a relative_path is a directory
 	bool				is_dir(const char* relative_path);
 	bool				is_dir(const char* relative_path);
 
 
-	/// Creates a regular file named @relative_path
+	/// Creates a regular file named @a relative_path
 	bool				create_file(const char* relative_path);
 	bool				create_file(const char* relative_path);
 
 
-	/// Creates a directory named @relative_path
+	/// Creates a directory named @a relative_path
 	bool				create_dir(const char* relative_path);
 	bool				create_dir(const char* relative_path);
 
 
-	/// Deletes the regular file @relative_path
+	/// Deletes the regular file @a relative_path
 	bool				delete_file(const char* relative_path);
 	bool				delete_file(const char* relative_path);
 
 
-	/// Deletes the directory @relative_path
+	/// Deletes the directory @a relative_path
 	bool				delete_dir(const char* relative_path);
 	bool				delete_dir(const char* relative_path);
 
 
-	/// Returns the os-specific path which @relative_path refers to.
+	/// Returns the os-specific path which @a relative_path refers to.
 	/// @note
 	/// @note
 	/// In general, you typically do not want to use it for normal
 	/// In general, you typically do not want to use it for normal
 	/// file interactions. Prefer using the other methods whenever possible.
 	/// file interactions. Prefer using the other methods whenever possible.
 	const char*			os_path(const char* relative_path);
 	const char*			os_path(const char* relative_path);
 
 
-	/// Opens the file @relative_path with the specified access @mode
+	/// Opens the file @a relative_path with the specified access @a mode
 	DiskFile*			open(const char* relative_path, FileOpenMode mode);
 	DiskFile*			open(const char* relative_path, FileOpenMode mode);
 
 
-	/// Closes a previously opened file @stream
+	/// Closes a previously opened file @a stream
 	void				close(DiskFile* stream);
 	void				close(DiskFile* stream);
 
 
 private:
 private:

+ 16 - 16
src/core/filesystem/MemoryFile.h

@@ -84,52 +84,52 @@ class MemoryFile: public File
 {
 {
 public:
 public:
 
 
-	/// @copydoc File::File()
+	/// @a copydoc File::File()
 						MemoryFile(MemoryBuffer* buffer, FileOpenMode mode);
 						MemoryFile(MemoryBuffer* buffer, FileOpenMode mode);
 
 
-	/// @copydoc File::~File()
+	/// @a copydoc File::~File()
 	virtual				~MemoryFile();
 	virtual				~MemoryFile();
 
 
-	/// @copydoc File::seek()
+	/// @a copydoc File::seek()
 	void				seek(size_t position);
 	void				seek(size_t position);
 
 
-	/// @copydoc File::seek_to_end()
+	/// @a copydoc File::seek_to_end()
 	void				seek_to_end();
 	void				seek_to_end();
 
 
-	/// @copydoc File::skip()
+	/// @a copydoc File::skip()
 	void				skip(size_t bytes);
 	void				skip(size_t bytes);
 
 
-	/// @copydoc File::read()
+	/// @a copydoc File::read()
 	void				read(void* buffer, size_t size);
 	void				read(void* buffer, size_t size);
 
 
-	/// @copydoc File::write()
+	/// @a copydoc File::write()
 	void				write(const void* buffer, size_t size);
 	void				write(const void* buffer, size_t size);
 
 
-	/// @copydoc File::copy_to()
+	/// @a copydoc File::copy_to()
 	bool				copy_to(File& file, size_t size = 0);
 	bool				copy_to(File& file, size_t size = 0);
 
 
-	/// @copydoc File::flush()
+	/// @a copydoc File::flush()
 	void				flush();
 	void				flush();
 
 
-	/// @copydoc File::end_of_file()
+	/// @a copydoc File::end_of_file()
 	bool				end_of_file() const { return size() == m_memory_offset; }
 	bool				end_of_file() const { return size() == m_memory_offset; }
 
 
-	/// @copydoc File::is_valid()
+	/// @a copydoc File::is_valid()
 	bool				is_valid() const { CE_ASSERT(m_memory != NULL, "Memory is NULL"); return m_memory->is_valid(); }
 	bool				is_valid() const { CE_ASSERT(m_memory != NULL, "Memory is NULL"); return m_memory->is_valid(); }
 
 
-	/// @copydoc File::size()
+	/// @a copydoc File::size()
 	size_t				size() const { CE_ASSERT(m_memory != NULL, "Memory is NULL"); return m_memory->size(); }
 	size_t				size() const { CE_ASSERT(m_memory != NULL, "Memory is NULL"); return m_memory->size(); }
 
 
-	/// @copydoc File::position()
+	/// @a copydoc File::position()
 	size_t				position() const { return m_memory_offset; }
 	size_t				position() const { return m_memory_offset; }
 
 
-	/// @copydoc File::can_read()
+	/// @a copydoc File::can_read()
 	bool				can_read() const { return true; }
 	bool				can_read() const { return true; }
 
 
-	/// @copydoc File::can_write()
+	/// @a copydoc File::can_write()
 	bool				can_write() const { return true; }
 	bool				can_write() const { return true; }
 
 
-	/// @copydoc File::can_seek()
+	/// @a copydoc File::can_seek()
 	bool				can_seek() const { return true; }
 	bool				can_seek() const { return true; }
 
 
 	/// Dumps the data to the console.
 	/// Dumps the data to the console.

+ 16 - 16
src/core/filesystem/NullFile.h

@@ -37,22 +37,22 @@ class NullFile: public File
 {
 {
 public:
 public:
 
 
-	/// @copydoc File::File()
+	/// @a copydoc File::File()
 				NullFile(FileOpenMode mode) : File(mode) {}
 				NullFile(FileOpenMode mode) : File(mode) {}
 
 
-	/// @copydoc File::~File()
+	/// @a copydoc File::~File()
 	virtual		~NullFile() {}
 	virtual		~NullFile() {}
 
 
-	/// @copydoc File::seek()
+	/// @a copydoc File::seek()
 	void		seek(size_t position) { (void)position; }
 	void		seek(size_t position) { (void)position; }
 
 
-	/// @copydoc File::seek_to_end()
+	/// @a copydoc File::seek_to_end()
 	void		seek_to_end() {}
 	void		seek_to_end() {}
 
 
-	/// @copydoc File::skip()
+	/// @a copydoc File::skip()
 	void		skip(size_t bytes) { (void)bytes; }
 	void		skip(size_t bytes) { (void)bytes; }
 				
 				
-	/// @copydoc File::read()
+	/// @a copydoc File::read()
 	/// @note
 	/// @note
 	///	Fills buffer with zeroes
 	///	Fills buffer with zeroes
 	void		read(void* buffer, size_t size)
 	void		read(void* buffer, size_t size)
@@ -63,10 +63,10 @@ public:
 		}
 		}
 	}
 	}
 
 
-	/// @copydoc File::write()
+	/// @a copydoc File::write()
 	void		write(const void* buffer, size_t size) { (void)buffer; (void)size; }
 	void		write(const void* buffer, size_t size) { (void)buffer; (void)size; }
 
 
-	/// @copydoc File::copy_to()
+	/// @a copydoc File::copy_to()
 	/// @note
 	/// @note
 	///	Returns always true
 	///	Returns always true
 	bool		copy_to(File& file, size_t size = 0)
 	bool		copy_to(File& file, size_t size = 0)
@@ -76,40 +76,40 @@ public:
 		return true;
 		return true;
 	}
 	}
 
 
-	/// @copydoc File::flush()
+	/// @a copydoc File::flush()
 	void		flush() {};
 	void		flush() {};
 				
 				
-	/// @copydoc File::is_valid()
+	/// @a copydoc File::is_valid()
 	/// @note
 	/// @note
 	///	Returns always true
 	///	Returns always true
 	bool		is_valid() { return true; }
 	bool		is_valid() { return true; }
 				
 				
-	/// @copydoc File::end_of_file()
+	/// @a copydoc File::end_of_file()
 	/// @note
 	/// @note
 	///	Returns always false
 	///	Returns always false
 	bool		end_of_file() { return false; }
 	bool		end_of_file() { return false; }
 				
 				
-	/// @copydoc File::size()
+	/// @a copydoc File::size()
 	/// @note
 	/// @note
 	///	Returns always 0xFFFFFFFF
 	///	Returns always 0xFFFFFFFF
 	size_t		size() { return ~0; }
 	size_t		size() { return ~0; }
 				
 				
-	/// @copydoc File::position()
+	/// @a copydoc File::position()
 	/// @note
 	/// @note
 	///	Returns always zero
 	///	Returns always zero
 	size_t		position() { return 0; }
 	size_t		position() { return 0; }
 				
 				
-	/// @copydoc File::can_read()
+	/// @a copydoc File::can_read()
 	/// @note
 	/// @note
 	///	Returns always true
 	///	Returns always true
 	bool		can_read() { return true; }
 	bool		can_read() { return true; }
 				
 				
-	/// @copydoc File::can_write()
+	/// @a copydoc File::can_write()
 	/// @note
 	/// @note
 	///	Returns always true
 	///	Returns always true
 	bool		can_write() { return true; }
 	bool		can_write() { return true; }
 				
 				
-	/// @copydoc File::can_seek()
+	/// @a copydoc File::can_seek()
 	/// @note
 	/// @note
 	///	Returns always true
 	///	Returns always true
 	bool		can_seek() { return true; }
 	bool		can_seek() { return true; }

+ 3 - 3
src/core/math/Interpolation.h

@@ -32,15 +32,15 @@ namespace crown
 namespace interpolation
 namespace interpolation
 {
 {
 
 
-/// Returns the linear interpolated value between @p0 and @p1 at time @t
+/// Returns the linear interpolated value between @a p0 and @a p1 at time @a t
 template <typename T>
 template <typename T>
 static T	linear(const T& p0, const T& p1, real t);
 static T	linear(const T& p0, const T& p1, real t);
 
 
-/// Returns the cosine interpolated value between @p0 and @p1 at time @t
+/// Returns the cosine interpolated value between @a p0 and @a p1 at time @a t
 template <typename T>
 template <typename T>
 static T	cosine(const T& p0, const T& p1, real t);
 static T	cosine(const T& p0, const T& p1, real t);
 
 
-/// Returns the cubic interpolated value between @p0 and @p1 at time @t
+/// Returns the cubic interpolated value between @a p0 and @a p1 at time @a t
 template <typename T>
 template <typename T>
 static T	cubic(const T& p0, const T& p1, real t);
 static T	cubic(const T& p0, const T& p1, real t);
 
 

+ 6 - 6
src/core/math/Mat3.h

@@ -45,7 +45,7 @@ class Vec3;
 /// to write something like: matrix vector. Since we are also using column vectors, inverting
 /// to write something like: matrix vector. Since we are also using column vectors, inverting
 /// the operands would result in an impossible operation.
 /// the operands would result in an impossible operation.
 /// 
 /// 
-/// @verbatim:
+/// @a verbatim:
 ///   X base vector
 ///   X base vector
 ///     | Y base vector
 ///     | Y base vector
 ///     |   | Z base vector
 ///     |   | Z base vector
@@ -67,7 +67,7 @@ public:
 	/// Constructs from a set of real
 	/// Constructs from a set of real
 						Mat3(real r1c1, real r2c1, real r3c1, real r1c2, real r2c2, real r3c2, real r1c3, real r2c3, real r3c3);
 						Mat3(real r1c1, real r2c1, real r3c1, real r1c2, real r2c2, real r3c2, real r1c3, real r2c3, real r3c3);
 	
 	
-	/// Constructs from the @v array
+	/// Constructs from the @a v array
 						Mat3(const real v[9]);						
 						Mat3(const real v[9]);						
 						Mat3(const Mat3& a);	
 						Mat3(const Mat3& a);	
 
 
@@ -98,13 +98,13 @@ public:
 	/// For simmetry
 	/// For simmetry
 	friend Mat3			operator*(real k, const Mat3& a);			
 	friend Mat3			operator*(real k, const Mat3& a);			
 
 
-	/// Builds a rotation matrix about the X axis of @radians radians
+	/// Builds a rotation matrix about the X axis of @a radians radians
 	void				build_rotation_x(real radians);			
 	void				build_rotation_x(real radians);			
 
 
-	/// Builds a rotation matrix about the Y axis of @radians radians	
+	/// Builds a rotation matrix about the Y axis of @a radians radians	
 	void				build_rotation_y(real radians);	
 	void				build_rotation_y(real radians);	
 
 
-	/// Builds a rotation matrix about the Z axis of @radians radians			
+	/// Builds a rotation matrix about the Z axis of @a radians radians			
 	void				build_rotation_z(real radians);	
 	void				build_rotation_z(real radians);	
 
 
 	/// Builds a rotation matrix about an arbitrary axis of "radians" radians			
 	/// Builds a rotation matrix about an arbitrary axis of "radians" radians			
@@ -122,7 +122,7 @@ public:
 	/// Returns a Vec3 containing the matrix's scale portion
 	/// Returns a Vec3 containing the matrix's scale portion
 	Vec3				get_scale() const;	
 	Vec3				get_scale() const;	
 
 
-	/// Fills the matrix's scale portion with the values contained in @scale				
+	/// Fills the matrix's scale portion with the values contained in @a scale				
 	void				set_scale(const Vec3& scale);				
 	void				set_scale(const Vec3& scale);				
 
 
 	/// Returns the pointer to the matrix's data
 	/// Returns the pointer to the matrix's data

+ 6 - 6
src/core/math/Mat4.h

@@ -46,7 +46,7 @@ class Vec4;
 /// to write something like: matrix * vector. Since we are also using column vectors, inverting
 /// to write something like: matrix * vector. Since we are also using column vectors, inverting
 /// the operands would result in an impossible operation.
 /// the operands would result in an impossible operation.
 /// 
 /// 
-/// @verbatim:
+/// @a verbatim:
 ///   X base vector
 ///   X base vector
 ///     | Y base vector
 ///     | Y base vector
 ///     |   | Z base vector
 ///     |   | Z base vector
@@ -70,7 +70,7 @@ public:
 	/// Constructs from a set of real
 	/// Constructs from a set of real
 						Mat4(real r1c1, real r2c1, real r3c1, real r4c1, real r1c2, real r2c2, real r3c2, real r4c2, real r1c3, real r2c3, real r3c3, real r4c3, real r1c4, real r2c4, real r3c4, real r4c4);
 						Mat4(real r1c1, real r2c1, real r3c1, real r4c1, real r1c2, real r2c2, real r3c2, real r4c2, real r1c3, real r2c3, real r3c3, real r4c3, real r1c4, real r2c4, real r3c4, real r4c4);
 	
 	
-	/// Contructs from the @v array
+	/// Contructs from the @a v array
 						Mat4(const real v[16]);						
 						Mat4(const real v[16]);						
 						Mat4(const Mat4& a);					
 						Mat4(const Mat4& a);					
 
 
@@ -101,13 +101,13 @@ public:
 	/// For simmetry
 	/// For simmetry
 	friend Mat4			operator*(real k, const Mat4& a);			
 	friend Mat4			operator*(real k, const Mat4& a);			
 
 
-	/// Builds a rotation matrix about the X axis of @radians radians
+	/// Builds a rotation matrix about the X axis of @a radians radians
 	void				build_rotation_x(real radians);
 	void				build_rotation_x(real radians);
 
 
 	/// Builds a rotation matrix about the Y axis of "radians" radians	
 	/// Builds a rotation matrix about the Y axis of "radians" radians	
 	void				build_rotation_y(real radians);	
 	void				build_rotation_y(real radians);	
 
 
-	/// Builds a rotation matrix about the Z axis of @radians radians			
+	/// Builds a rotation matrix about the Z axis of @a radians radians			
 	void				build_rotation_z(real radians);		
 	void				build_rotation_z(real radians);		
 
 
 	/// Builds a rotation matrix about an arbitrary axis of "radians" radians		
 	/// Builds a rotation matrix about an arbitrary axis of "radians" radians		
@@ -152,13 +152,13 @@ public:
 	/// Returns a Vec3 containing the matrix's translation portion
 	/// Returns a Vec3 containing the matrix's translation portion
 	Vec3				get_translation() const;	
 	Vec3				get_translation() const;	
 
 
-	/// Fills the matrix's translation portion values contained in @trans				
+	/// Fills the matrix's translation portion values contained in @a trans				
 	void				set_translation(const Vec3& trans);			
 	void				set_translation(const Vec3& trans);			
 
 
 	/// Returns a Vec3 containing the matrix's scale portion
 	/// Returns a Vec3 containing the matrix's scale portion
 	Vec3				get_scale() const;
 	Vec3				get_scale() const;
 
 
-	/// Fills the matrix's scale portion with the values contained in @scale							
+	/// Fills the matrix's scale portion with the values contained in @a scale							
 	void				set_scale(const Vec3& scale);				
 	void				set_scale(const Vec3& scale);				
 
 
 	/// Returns the pointer to the matrix's data
 	/// Returns the pointer to the matrix's data

+ 22 - 22
src/core/math/MathUtils.h

@@ -60,73 +60,73 @@ const double	DOUBLE_PRECISION			= (real)1.0e-9;
 bool			equals(float a, float b, float precision = FLOAT_PRECISION);
 bool			equals(float a, float b, float precision = FLOAT_PRECISION);
 bool			equals(double a, double b, double precision = DOUBLE_PRECISION);
 bool			equals(double a, double b, double precision = DOUBLE_PRECISION);
 
 
-/// Tests agains the specified @bitmask and returns true only if all bits are satisfied
+/// Tests agains the specified @a bitmask and returns true only if all bits are satisfied
 bool			test_bitmask(int32_t value, int32_t bitmask);
 bool			test_bitmask(int32_t value, int32_t bitmask);
 
 
-/// Sets the specified @bitmask	
+/// Sets the specified @a bitmask	
 int32_t			set_bitmask(int32_t value, int32_t bitmask);
 int32_t			set_bitmask(int32_t value, int32_t bitmask);
 
 
-/// Removes the specified @bitmask	
+/// Removes the specified @a bitmask	
 int32_t			unset_bitmask(int32_t value, int32_t bitmask);	
 int32_t			unset_bitmask(int32_t value, int32_t bitmask);	
 
 
-/// Returns minimum between @a and @b
+/// Returns minimum between @a a and @a b
 template <typename T> T		min(const T& a, const T& b);
 template <typename T> T		min(const T& a, const T& b);
 
 
-/// Returns maximum between @a and @b
+/// Returns maximum between @a a and @a b
 template <typename T> T		max(const T& a, const T& b);
 template <typename T> T		max(const T& a, const T& b);
 
 
-/// Returns the arithmetic mean of @a and @b	
+/// Returns the arithmetic mean of @a a and @a b	
 template <typename T> T		avg(const T& a, const T& b);
 template <typename T> T		avg(const T& a, const T& b);
 
 
 /// Clamps a value to a specific range (min < max)	
 /// Clamps a value to a specific range (min < max)	
 template <typename T> T		clamp_to_range(const T& min, const T& max, const T& value);	
 template <typename T> T		clamp_to_range(const T& min, const T& max, const T& value);	
 
 
-/// Swaps @a and @b
+/// Swaps @a a and @a b
 template <typename T> void	swap(T& a, T& b);				
 template <typename T> void	swap(T& a, T& b);				
 
 
-/// Returns @deg in radians
+/// Returns @a deg in radians
 real			deg_to_rad(real deg);
 real			deg_to_rad(real deg);
 
 
-/// Returns @rad in degrees
+/// Returns @a rad in degrees
 real			rad_to_deg(real rad);
 real			rad_to_deg(real rad);
 
 
-/// Returns the nearest power of two to @x
+/// Returns the nearest power of two to @a x
 uint32_t		next_pow_2(uint32_t x);
 uint32_t		next_pow_2(uint32_t x);
 
 
-/// Returns whether @x is a power of two			
+/// Returns whether @a x is a power of two			
 bool			is_pow_2(uint32_t x);	
 bool			is_pow_2(uint32_t x);	
 
 
-/// Returns the smallest integral value that is not less than @x
+/// Returns the smallest integral value that is not less than @a x
 real			ceil(real x);		
 real			ceil(real x);		
 
 
-/// Returns the largest integral value that is not greater than @x			
+/// Returns the largest integral value that is not greater than @a x			
 real			floor(real x);	
 real			floor(real x);	
 
 
-/// Returns the square root of @x				
+/// Returns the square root of @a x				
 real			sqrt(real x);	
 real			sqrt(real x);	
 
 
-/// Returns the inverse square root of @x				
+/// Returns the inverse square root of @a x				
 real			inv_sqrt(real x);
 real			inv_sqrt(real x);
 
 
-/// Returns the sine of @x				
+/// Returns the sine of @a x				
 real			sin(real x);	
 real			sin(real x);	
 
 
-/// Returns the cosine of @x				
+/// Returns the cosine of @a x				
 real			cos(real x);
 real			cos(real x);
 
 
-/// Returns the arc sine of @x					
+/// Returns the arc sine of @a x					
 real			asin(real x);	
 real			asin(real x);	
 
 
-/// Returns the arc cosine of @x				
+/// Returns the arc cosine of @a x				
 real			acos(real x);	
 real			acos(real x);	
 
 
-/// Returns the tangent of @x				
+/// Returns the tangent of @a x				
 real			tan(real x);		
 real			tan(real x);		
 
 
-/// Returns the arc tangent of @y/@x			
+/// Returns the arc tangent of @a y/@a x			
 real			atan2(real y, real x);	
 real			atan2(real y, real x);	
 
 
-/// Returns the absolute value of @x		
+/// Returns the absolute value of @a x		
 real			abs(real x);			
 real			abs(real x);			
 
 
 /// Returns the realing-point remainder of numerator/denominator		
 /// Returns the realing-point remainder of numerator/denominator		

+ 2 - 2
src/core/math/Plane.h

@@ -55,10 +55,10 @@ public:
 	/// Normalizes the plane
 	/// Normalizes the plane
 	Plane&				normalize();							
 	Plane&				normalize();							
 
 
-	/// Returns the signed distance between point @p and the plane
+	/// Returns the signed distance between point @a p and the plane
 	real				distance_to_point(const Vec3& p) const;	
 	real				distance_to_point(const Vec3& p) const;	
 
 
-	/// Returns whether the plane contains the point @p	
+	/// Returns whether the plane contains the point @a p	
 	bool				contains_point(const Vec3& p) const;		
 	bool				contains_point(const Vec3& p) const;		
 
 
 	static const Plane	ZERO;
 	static const Plane	ZERO;

+ 1 - 1
src/core/math/Quat.h

@@ -36,7 +36,7 @@ class Mat4;
 
 
 /// Quaternion.
 /// Quaternion.
 ///
 ///
-/// @Note:
+/// @a Note:
 /// This implementation uses the standard quaternion
 /// This implementation uses the standard quaternion
 /// multiplication equation, so, the order of multiplication
 /// multiplication equation, so, the order of multiplication
 /// for multiple rotations is in a reverse fashion:
 /// for multiple rotations is in a reverse fashion:

+ 1 - 1
src/core/math/Random.h

@@ -35,7 +35,7 @@ class Random
 {
 {
 public:
 public:
 
 
-	/// Initializes the generator with the given @seed.
+	/// Initializes the generator with the given @a seed.
 				Random(int32_t seed);
 				Random(int32_t seed);
 
 
 	/// Returns a pseudo-random integer in the range [0, 32767].
 	/// Returns a pseudo-random integer in the range [0, 32767].

+ 1 - 1
src/core/math/Ray.h

@@ -41,7 +41,7 @@ public:
 	/// Does nothing for efficiency.
 	/// Does nothing for efficiency.
 					Ray();
 					Ray();
 
 
-	/// Constructs from @origin and @direction
+	/// Constructs from @a origin and @a direction
 					Ray(const Vec3& origin, const Vec3& direction);
 					Ray(const Vec3& origin, const Vec3& direction);
 					Ray(const Ray& ray);
 					Ray(const Ray& ray);
 
 

+ 2 - 2
src/core/math/Triangle.h

@@ -50,10 +50,10 @@ public:
 	/// Returns the center of gravity (a.k.a. "centroid").
 	/// Returns the center of gravity (a.k.a. "centroid").
 	Vec3		centroid() const;
 	Vec3		centroid() const;
 
 
-	/// Returns the barycentric coordinates of point @p in respect to the triangle.
+	/// Returns the barycentric coordinates of point @a p in respect to the triangle.
 	Vec3		barycentric_coords(const Vec3& p) const;
 	Vec3		barycentric_coords(const Vec3& p) const;
 
 
-	/// Returns whether the triangle contains the @p point.
+	/// Returns whether the triangle contains the @a p point.
 	bool		contains_point(const Vec3& p) const;
 	bool		contains_point(const Vec3& p) const;
 
 
 	/// Returns the plane containing the triangle.
 	/// Returns the plane containing the triangle.

+ 2 - 2
src/core/math/Vec2.h

@@ -76,10 +76,10 @@ public:
 	bool				operator==(const Vec2& other) const;	
 	bool				operator==(const Vec2& other) const;	
 	bool				operator!=(const Vec2& other) const;
 	bool				operator!=(const Vec2& other) const;
 
 
-	/// Returns whether all the components of this vector are smaller than all of the @other vector	
+	/// Returns whether all the components of this vector are smaller than all of the @a other vector	
 	bool				operator<(const Vec2& other) const;		
 	bool				operator<(const Vec2& other) const;		
 
 
-	/// Returns whether all the components of this vector are greater than all of the @other vector
+	/// Returns whether all the components of this vector are greater than all of the @a other vector
 	bool				operator>(const Vec2& other) const;		
 	bool				operator>(const Vec2& other) const;		
 
 
 	/// Returns the vector's length
 	/// Returns the vector's length

+ 2 - 2
src/core/math/Vec4.h

@@ -76,10 +76,10 @@ public:
 	bool				operator==(const Vec4& other) const;		
 	bool				operator==(const Vec4& other) const;		
 	bool				operator!=(const Vec4& other) const;
 	bool				operator!=(const Vec4& other) const;
 
 
-	/// Returns whether all the components of this vector are smaller than all of the @other vector	
+	/// Returns whether all the components of this vector are smaller than all of the @a other vector	
 	bool				operator<(const Vec4& other) const;	
 	bool				operator<(const Vec4& other) const;	
 
 
-	/// Returns whether all the components of this vector are greater than all of the @other vector		
+	/// Returns whether all the components of this vector are greater than all of the @a other vector		
 	bool				operator>(const Vec4& other) const;			
 	bool				operator>(const Vec4& other) const;			
 
 
 	/// Returns the vector's length
 	/// Returns the vector's length

+ 4 - 4
src/core/mem/Allocator.h

@@ -38,11 +38,11 @@ public:
 
 
 	virtual				~Allocator() {}
 	virtual				~Allocator() {}
 
 
-	/// Allocates @size bytes of memory aligned to the specified
-	/// @align byte and returns a pointer to the first allocated byte.
+	/// Allocates @a size bytes of memory aligned to the specified
+	/// @a align byte and returns a pointer to the first allocated byte.
 	virtual void*		allocate(size_t size, size_t align = memory::DEFAULT_ALIGN) = 0;
 	virtual void*		allocate(size_t size, size_t align = memory::DEFAULT_ALIGN) = 0;
 
 
-	/// Deallocates a previously allocated block of memory pointed by @data.
+	/// Deallocates a previously allocated block of memory pointed by @a data.
 	virtual void		deallocate(void* data) = 0;
 	virtual void		deallocate(void* data) = 0;
 
 
 	/// Returns the total number of bytes allocated.
 	/// Returns the total number of bytes allocated.
@@ -51,7 +51,7 @@ public:
 
 
 Allocator& default_allocator();
 Allocator& default_allocator();
 
 
-/// Respects standard behaviour when calling on NULL @ptr
+/// Respects standard behaviour when calling on NULL @a ptr
 template <typename T>
 template <typename T>
 void call_destructor_and_deallocate(Allocator& a, T* ptr)
 void call_destructor_and_deallocate(Allocator& a, T* ptr)
 {
 {

+ 4 - 4
src/core/mem/MallocAllocator.h

@@ -38,16 +38,16 @@ public:
 				MallocAllocator();
 				MallocAllocator();
 				~MallocAllocator();
 				~MallocAllocator();
 
 
-	/// @copydoc Allocator::allocate()
+	/// @a copydoc Allocator::allocate()
 	void*		allocate(size_t size, size_t align = memory::DEFAULT_ALIGN);
 	void*		allocate(size_t size, size_t align = memory::DEFAULT_ALIGN);
 
 
-	/// @copydoc Allocator::deallocate()
+	/// @a copydoc Allocator::deallocate()
 	void		deallocate(void* data);
 	void		deallocate(void* data);
 
 
-	/// @copydoc Allocator::allocated_size()
+	/// @a copydoc Allocator::allocated_size()
 	size_t		allocated_size();
 	size_t		allocated_size();
 
 
-	/// Returns the size in bytes of the block of memory pointed by @data
+	/// Returns the size in bytes of the block of memory pointed by @a data
 	size_t		get_size(void* data);
 	size_t		get_size(void* data);
 
 
 private:
 private:

+ 1 - 1
src/core/mem/Memory.h

@@ -38,7 +38,7 @@ namespace memory
 const uint32_t	PADDING_VALUE	= 0xFFFFFFFFu;	//!< Value used to fill unused memory
 const uint32_t	PADDING_VALUE	= 0xFFFFFFFFu;	//!< Value used to fill unused memory
 const size_t	DEFAULT_ALIGN	= 4;			//!< Default memory alignment in bytes
 const size_t	DEFAULT_ALIGN	= 4;			//!< Default memory alignment in bytes
 
 
-/// Returns the pointer @p aligned to the desired @align byte
+/// Returns the pointer @a p aligned to the desired @a align byte
 inline void* align(void* p, size_t align)
 inline void* align(void* p, size_t align)
 {
 {
 	uintptr_t ptr = (uintptr_t)p;
 	uintptr_t ptr = (uintptr_t)p;

+ 3 - 3
src/core/mem/ProxyAllocator.h

@@ -38,13 +38,13 @@ class ProxyAllocator
 {
 {
 public:
 public:
 
 
-	/// Tag all allocations made with @allocator by the given @name
+	/// Tag all allocations made with @a allocator by the given @a name
 					ProxyAllocator(const char* name, Allocator& allocator);
 					ProxyAllocator(const char* name, Allocator& allocator);
 
 
-	/// @copydoc Allocator::allocate()
+	/// @a copydoc Allocator::allocate()
 	void*			allocate(size_t size, size_t align = memory::DEFAULT_ALIGN);
 	void*			allocate(size_t size, size_t align = memory::DEFAULT_ALIGN);
 
 
-	/// @copydoc Allocator::deallocate()
+	/// @a copydoc Allocator::deallocate()
 	void			deallocate(void* data);
 	void			deallocate(void* data);
 
 
 	/// Returns the name of the proxy allocator
 	/// Returns the name of the proxy allocator

+ 6 - 6
src/core/strings/Path.h

@@ -143,7 +143,7 @@ inline bool is_valid_path(const char* path)
 /// e.g. "/home" -> "/"
 /// e.g. "/home" -> "/"
 /// e.g. "home" -> ""
 /// e.g. "home" -> ""
 /// 
 /// 
-/// The @path must be valid.
+/// The @a path must be valid.
 inline void pathname(const char* path, char* str, size_t len)
 inline void pathname(const char* path, char* str, size_t len)
 {
 {
 	CE_ASSERT(path != NULL, "Path must be != NULL");
 	CE_ASSERT(path != NULL, "Path must be != NULL");
@@ -168,7 +168,7 @@ inline void pathname(const char* path, char* str, size_t len)
 /// e.g. "/home -> "home"
 /// e.g. "/home -> "home"
 /// e.g. "/" -> ""
 /// e.g. "/" -> ""
 ///
 ///
-/// The @path must be valid.
+/// The @a path must be valid.
 inline void filename(const char* path, char* str, size_t len)
 inline void filename(const char* path, char* str, size_t len)
 {
 {
 	CE_ASSERT(path != NULL, "Path must be != NULL");
 	CE_ASSERT(path != NULL, "Path must be != NULL");
@@ -192,7 +192,7 @@ inline void filename(const char* path, char* str, size_t len)
 /// e.g. "/home/project" -> "project"
 /// e.g. "/home/project" -> "project"
 /// e.g. "/" -> ""
 /// e.g. "/" -> ""
 ///
 ///
-/// The @path must be valid.
+/// The @a path must be valid.
 inline void basename(const char* path, char* str, size_t len)
 inline void basename(const char* path, char* str, size_t len)
 {
 {
 	CE_ASSERT(path != NULL, "Path must be != NULL");
 	CE_ASSERT(path != NULL, "Path must be != NULL");
@@ -224,7 +224,7 @@ inline void basename(const char* path, char* str, size_t len)
 /// e.g. "/home/project/texture.tga" -> "tga"
 /// e.g. "/home/project/texture.tga" -> "tga"
 /// e.g. "/home/project.x/texture" -> ""
 /// e.g. "/home/project.x/texture" -> ""
 ///
 ///
-/// The @path must be valid.
+/// The @a path must be valid.
 inline void extension(const char* path, char* str, size_t len)
 inline void extension(const char* path, char* str, size_t len)
 {
 {
 	CE_ASSERT(path != NULL, "Path must be != NULL");
 	CE_ASSERT(path != NULL, "Path must be != NULL");
@@ -247,7 +247,7 @@ inline void extension(const char* path, char* str, size_t len)
 /// e.g. "/home/project/texture.tga" -> "/home/project/texture"
 /// e.g. "/home/project/texture.tga" -> "/home/project/texture"
 /// e.g. "/home/project/texture" -> "/home/project/texture"
 /// e.g. "/home/project/texture" -> "/home/project/texture"
 ///
 ///
-/// The @path must be valid.
+/// The @a path must be valid.
 inline void filename_without_extension(const char* path, char* str, size_t len)
 inline void filename_without_extension(const char* path, char* str, size_t len)
 {
 {
 	CE_ASSERT(path != NULL, "Path must be != NULL");
 	CE_ASSERT(path != NULL, "Path must be != NULL");
@@ -276,7 +276,7 @@ inline void filename_without_extension(const char* path, char* str, size_t len)
 /// e.g. "/home/project/texture.tga/" -> "/home/project/texture.tga"
 /// e.g. "/home/project/texture.tga/" -> "/home/project/texture.tga"
 /// e.g. "/home/project/texture.tga" -> "/home/project/texture.tga"
 /// e.g. "/home/project/texture.tga" -> "/home/project/texture.tga"
 ///
 ///
-/// The @path must be valid.
+/// The @a path must be valid.
 inline void strip_trailing_separator(const char* path, char* str, size_t len)
 inline void strip_trailing_separator(const char* path, char* str, size_t len)
 {
 {
 	CE_ASSERT(path != NULL, "Path must be != NULL");
 	CE_ASSERT(path != NULL, "Path must be != NULL");

+ 3 - 3
src/input/Keyboard.h

@@ -66,7 +66,7 @@ public:
 
 
 					Keyboard();
 					Keyboard();
 
 
-	/// Returns whether the specified @modifier is pressed.
+	/// Returns whether the specified @a modifier is pressed.
 	/// @note
 	/// @note
 	/// A modifier is a special key that modifies the normal action
 	/// A modifier is a special key that modifies the normal action
 	/// of another key when the two are pressed in combination. (Thanks wikipedia.)
 	/// of another key when the two are pressed in combination. (Thanks wikipedia.)
@@ -74,10 +74,10 @@ public:
 	/// Crown currently supports three different modifier keys: Shift, Ctrl and Alt.
 	/// Crown currently supports three different modifier keys: Shift, Ctrl and Alt.
 	bool			modifier_pressed(ModifierKey modifier) const;
 	bool			modifier_pressed(ModifierKey modifier) const;
 
 
-	/// Returns whether the specified @key is pressed.
+	/// Returns whether the specified @a key is pressed.
 	bool			key_pressed(KeyCode key) const;
 	bool			key_pressed(KeyCode key) const;
 
 
-	/// Returns whether the specified @key is released.
+	/// Returns whether the specified @a key is released.
 	bool			key_released(KeyCode key) const;
 	bool			key_released(KeyCode key) const;
 
 
 private:
 private:

+ 2 - 2
src/input/Mouse.h

@@ -69,10 +69,10 @@ public:
 			Mouse();
 			Mouse();
 
 
 
 
-	/// Returns whether @button is pressed.
+	/// Returns whether @a button is pressed.
 	bool	button_pressed(MouseButton button) const;
 	bool	button_pressed(MouseButton button) const;
 
 
-	/// Returns whether @button is released.
+	/// Returns whether @a button is released.
 	bool	button_released(MouseButton button) const;
 	bool	button_released(MouseButton button) const;
 
 
 	/// Returns the position of the cursor in window space.
 	/// Returns the position of the cursor in window space.

+ 4 - 4
src/input/Touch.h

@@ -69,20 +69,20 @@ public:
 
 
 					Touch();
 					Touch();
 
 
-	/// Returns whether the touch pointer @id is up.
+	/// Returns whether the touch pointer @a id is up.
 	bool			touch_up(uint16_t id) const;
 	bool			touch_up(uint16_t id) const;
 
 
-	/// Returns whether the touch pointer @id is down.
+	/// Returns whether the touch pointer @a id is down.
 	bool			touch_down(uint16_t id) const;
 	bool			touch_down(uint16_t id) const;
 
 
-	/// Returns the position of the pointer @id in windows space.
+	/// Returns the position of the pointer @a id in windows space.
 	/// @note
 	/// @note
 	/// Coordinates in window space have the origin at the
 	/// Coordinates in window space have the origin at the
 	/// upper-left corner of the window. +X extends from left
 	/// upper-left corner of the window. +X extends from left
 	/// to right and +Y extends from top to bottom.
 	/// to right and +Y extends from top to bottom.
 	Point2			touch_xy(uint16_t id) const;
 	Point2			touch_xy(uint16_t id) const;
 
 
-	/// Returns the relative position of the pointer @id in window space.
+	/// Returns the relative position of the pointer @a id in window space.
 	/// @note
 	/// @note
 	/// Coordinates in window space have the origin at the
 	/// Coordinates in window space have the origin at the
 	/// upper-left corner of the window. +X extends from left
 	/// upper-left corner of the window. +X extends from left

+ 1 - 1
src/network/BitMessage.h

@@ -35,7 +35,7 @@ namespace network
 {
 {
 
 
 /// Bit-packet reliable message.
 /// Bit-packet reliable message.
-/// Usage: After every instantition, must be initialized with @init(len)
+/// Usage: After every instantition, must be initialized with @a init(len)
 /// TODO: rework as POD is needed; this feature provides compatibility with queue
 /// TODO: rework as POD is needed; this feature provides compatibility with queue
 class BitMessage
 class BitMessage
 {
 {

+ 1 - 1
src/os/OS.h

@@ -150,7 +150,7 @@ struct OSEvent
 	OSEventParameter	data_d;
 	OSEventParameter	data_d;
 };
 };
 
 
-/// Pushes the event @type along with its parameters into the os' event queue.
+/// Pushes the event @a type along with its parameters into the os' event queue.
 void			push_event(OSEventType type, OSEventParameter data_a, OSEventParameter data_b, OSEventParameter data_c, OSEventParameter data_d);
 void			push_event(OSEventType type, OSEventParameter data_a, OSEventParameter data_b, OSEventParameter data_c, OSEventParameter data_d);
 
 
 
 

+ 5 - 5
src/os/android/OsFile.h

@@ -39,7 +39,7 @@ class OsFile
 {
 {
 public:
 public:
 
 
-	/// Opens the file located at @path with the given @mode.
+	/// Opens the file located at @a path with the given @a mode.
 							OsFile(const char* path, FileOpenMode mode);
 							OsFile(const char* path, FileOpenMode mode);
 							~OsFile();
 							~OsFile();
 
 
@@ -54,21 +54,21 @@ public:
 	/// Returs the mode used to open the file.
 	/// Returs the mode used to open the file.
 	FileOpenMode			mode() const;
 	FileOpenMode			mode() const;
 
 
-	/// Reads @size bytes from the file and stores it into @data.
+	/// Reads @a size bytes from the file and stores it into @a data.
 	/// Returns the number of bytes read.
 	/// Returns the number of bytes read.
 	size_t					read(void* data, size_t size);
 	size_t					read(void* data, size_t size);
 
 
-	/// Writes @size bytes of data stored in @data and returns the
+	/// Writes @a size bytes of data stored in @a data and returns the
 	/// number of bytes written.
 	/// number of bytes written.
 	size_t					write(const void* data, size_t size);
 	size_t					write(const void* data, size_t size);
 
 
-	/// Moves the file pointer to the given @position.
+	/// Moves the file pointer to the given @a position.
 	void					seek(size_t position);
 	void					seek(size_t position);
 
 
 	/// Moves the file pointer to the end of the file.
 	/// Moves the file pointer to the end of the file.
 	void					seek_to_end();
 	void					seek_to_end();
 
 
-	/// Moves the file pointer @bytes bytes ahead the current
+	/// Moves the file pointer @a bytes bytes ahead the current
 	/// file pointer position.
 	/// file pointer position.
 	void					skip(size_t bytes);
 	void					skip(size_t bytes);
 
 

+ 5 - 5
src/os/posix/OsFile.h

@@ -38,7 +38,7 @@ class OsFile
 {
 {
 public:
 public:
 
 
-	/// Opens the file located at @path with the given @mode.
+	/// Opens the file located at @a path with the given @a mode.
 							OsFile(const char* path, FileOpenMode mode);
 							OsFile(const char* path, FileOpenMode mode);
 							~OsFile();
 							~OsFile();
 
 
@@ -53,21 +53,21 @@ public:
 	/// Returs the mode used to open the file.
 	/// Returs the mode used to open the file.
 	FileOpenMode			mode();
 	FileOpenMode			mode();
 
 
-	/// Reads @size bytes from the file and stores it into @data.
+	/// Reads @a size bytes from the file and stores it into @a data.
 	/// Returns the number of bytes read.
 	/// Returns the number of bytes read.
 	size_t					read(void* data, size_t size);
 	size_t					read(void* data, size_t size);
 
 
-	/// Writes @size bytes of data stored in @data and returns the
+	/// Writes @a size bytes of data stored in @a data and returns the
 	/// number of bytes written.
 	/// number of bytes written.
 	size_t					write(const void* data, size_t size);
 	size_t					write(const void* data, size_t size);
 
 
-	/// Moves the file pointer to the given @position.
+	/// Moves the file pointer to the given @a position.
 	void					seek(size_t position);
 	void					seek(size_t position);
 
 
 	/// Moves the file pointer to the end of the file.
 	/// Moves the file pointer to the end of the file.
 	void					seek_to_end();
 	void					seek_to_end();
 
 
-	/// Moves the file pointer @bytes bytes ahead the current
+	/// Moves the file pointer @a bytes bytes ahead the current
 	/// file pointer position.
 	/// file pointer position.
 	void					skip(size_t bytes);
 	void					skip(size_t bytes);
 
 

+ 1 - 1
src/os/win/WinKeyboard.cpp

@@ -181,7 +181,7 @@ Key WinKeyboard::TranslateKey(int32_t winKey)
 		case VK_RCONTROL:	return KC_RCONTROL;
 		case VK_RCONTROL:	return KC_RCONTROL;
 		case VK_CAPITAL:	return KC_CAPS_LOCK;
 		case VK_CAPITAL:	return KC_CAPS_LOCK;
 		case VK_LMENU:		return KC_LALT;
 		case VK_LMENU:		return KC_LALT;
-		case VK_RMENU:		return KC_RALT;
+		case VK_@noteNU:		return KC_RALT;
 		case VK_LWIN:		return KC_LSUPER;
 		case VK_LWIN:		return KC_LSUPER;
 		case VK_RWIN:		return KC_RSUPER;
 		case VK_RWIN:		return KC_RSUPER;
 		case VK_NUMPAD0:	return KC_KP_0;
 		case VK_NUMPAD0:	return KC_KP_0;

+ 7 - 7
src/os/win/WinKeyboard.h

@@ -39,27 +39,27 @@ class WinKeyboard : public Keyboard
 
 
 public:
 public:
 
 
-	/** @copydoc Keyboard::Keyboard() */
+	/** @a copydoc Keyboard::Keyboard() */
 	WinKeyboard(InputManager* creator);
 	WinKeyboard(InputManager* creator);
 
 
-	/** @copydoc Keyboard::~Keyboard() */
+	/** @a copydoc Keyboard::~Keyboard() */
 	~WinKeyboard();
 	~WinKeyboard();
 
 
-	/** @copydoc Keyboard::IsModifierPressed() */
+	/** @a copydoc Keyboard::IsModifierPressed() */
 	virtual bool IsModifierPressed(ModifierKey modifier) const;
 	virtual bool IsModifierPressed(ModifierKey modifier) const;
 
 
-	/** @copydoc Keyboard::IsKeyPressed() */
+	/** @a copydoc Keyboard::IsKeyPressed() */
 	virtual bool IsKeyPressed(KeyCode key) const;
 	virtual bool IsKeyPressed(KeyCode key) const;
 
 
-	/** @copydoc Keyboard::IsKeyReleased() */
+	/** @a copydoc Keyboard::IsKeyReleased() */
 	virtual bool IsKeyReleased(KeyCode key) const;
 	virtual bool IsKeyReleased(KeyCode key) const;
 
 
-	/** @copydoc Keyboard::EventLoop() */
+	/** @a copydoc Keyboard::EventLoop() */
 	virtual void EventLoop();
 	virtual void EventLoop();
 
 
 	/**
 	/**
 		Returns whether DetectableAutoRepeat is set.
 		Returns whether DetectableAutoRepeat is set.
-	@return
+	@a return
 		True if set, false otherwise
 		True if set, false otherwise
 	*/
 	*/
 	inline bool HasDetectableAutoRepeat() { return mDetectableAutoRepeat; }
 	inline bool HasDetectableAutoRepeat() { return mDetectableAutoRepeat; }

+ 9 - 9
src/os/win/WinMouse.h

@@ -39,31 +39,31 @@ class WinMouse : public Mouse
 
 
 public:
 public:
 
 
-	/** @copydoc Mouse::Mouse() */
+	/** @a copydoc Mouse::Mouse() */
 	WinMouse(InputManager* creator);
 	WinMouse(InputManager* creator);
 
 
-	/** @copydoc Mouse::~Mouse() */
+	/** @a copydoc Mouse::~Mouse() */
 	~WinMouse();
 	~WinMouse();
 
 
-	/** @copydoc Mouse::IsVisible() */
+	/** @a copydoc Mouse::IsVisible() */
 	virtual bool IsCursorVisible() const;
 	virtual bool IsCursorVisible() const;
 
 
-	/** @copydoc Mouse::SetVisible() */
+	/** @a copydoc Mouse::SetVisible() */
 	virtual void SetCursorVisible(bool visible);
 	virtual void SetCursorVisible(bool visible);
 
 
-	/** @copydoc Mouse::GetCursorXY() */
+	/** @a copydoc Mouse::GetCursorXY() */
 	virtual Point32_t2 GetCursorXY() const;
 	virtual Point32_t2 GetCursorXY() const;
 
 
-	/** @copydoc Mouse::SetCursorXY() */
+	/** @a copydoc Mouse::SetCursorXY() */
 	virtual void SetCursorXY(const Point32_t2& position);
 	virtual void SetCursorXY(const Point32_t2& position);
 
 
-	/** @copydoc Mouse::GetCursorRelativeXY() */
+	/** @a copydoc Mouse::GetCursorRelativeXY() */
 	virtual Vec2 GetCursorRelativeXY() const;
 	virtual Vec2 GetCursorRelativeXY() const;
 
 
-	/** @copydoc Mouse::SetCursorRelativeXY() */
+	/** @a copydoc Mouse::SetCursorRelativeXY() */
 	virtual void SetCursorRelativeXY(const Vec2& position);
 	virtual void SetCursorRelativeXY(const Vec2& position);
 
 
-	/** @copydoc Mouse::EventLoop() */
+	/** @a copydoc Mouse::EventLoop() */
 	virtual void EventLoop();
 	virtual void EventLoop();
 
 
 private:
 private:

+ 2 - 2
src/renderers/PixelFormat.h

@@ -102,10 +102,10 @@ class Pixel
 {
 {
 public:
 public:
 
 
-	/// Returns the bytes occupied by @format
+	/// Returns the bytes occupied by @a format
 	static size_t bytes_per_pixel(PixelFormat format);
 	static size_t bytes_per_pixel(PixelFormat format);
 
 
-	/// Returns the bits occupied by @format
+	/// Returns the bits occupied by @a format
 	static size_t bits_per_pixel(PixelFormat format);
 	static size_t bits_per_pixel(PixelFormat format);
 
 
 private:
 private:

+ 13 - 13
src/renderers/Renderer.h

@@ -76,29 +76,29 @@ public:
 	virtual ~Renderer() {}
 	virtual ~Renderer() {}
 
 
 	/// Creates a new vertex buffer optimized for rendering static vertex data.
 	/// Creates a new vertex buffer optimized for rendering static vertex data.
-	/// @vertices is the array containig @count vertex data elements of the given @format.
+	/// @a vertices is the array containig @a count vertex data elements of the given @a format.
 	virtual VertexBufferId	create_vertex_buffer(size_t count, VertexFormat format, const void* vertices) = 0;
 	virtual VertexBufferId	create_vertex_buffer(size_t count, VertexFormat format, const void* vertices) = 0;
 
 
 	/// Creates a new vertex buffer optimized for rendering dynamic vertex data.
 	/// Creates a new vertex buffer optimized for rendering dynamic vertex data.
-	/// @vertices is the array containig @count vertex data elements of the given @format.
+	/// @a vertices is the array containig @a count vertex data elements of the given @a format.
 	virtual VertexBufferId	create_dynamic_vertex_buffer(size_t count, VertexFormat format, const void* vertices) = 0;
 	virtual VertexBufferId	create_dynamic_vertex_buffer(size_t count, VertexFormat format, const void* vertices) = 0;
 
 
-	/// Updates the data associated with the given vertex buffer @id.
-	/// @vertices is the array containig @count vertex data elements of the format
+	/// Updates the data associated with the given vertex buffer @a id.
+	/// @a vertices is the array containig @a count vertex data elements of the format
 	/// specified at the creation of the buffer.
 	/// specified at the creation of the buffer.
 	/// @note
 	/// @note
-	/// @count and @offset together do not have to exceed the number of elements specified
+	/// @a count and @a offset together do not have to exceed the number of elements specified
 	/// at the creation of the buffer.	
 	/// at the creation of the buffer.	
 	virtual void			update_vertex_buffer(VertexBufferId id, size_t offset, size_t count, const void* vertices) = 0;
 	virtual void			update_vertex_buffer(VertexBufferId id, size_t offset, size_t count, const void* vertices) = 0;
 
 
-	/// Destroys the @id vertex buffer.
+	/// Destroys the @a id vertex buffer.
 	virtual void			destroy_vertex_buffer(VertexBufferId id) = 0;
 	virtual void			destroy_vertex_buffer(VertexBufferId id) = 0;
 
 
 	/// Creates a new index buffer optimized for rendering static index buffers.
 	/// Creates a new index buffer optimized for rendering static index buffers.
-	/// @indices is the array containing @count index data elements.
+	/// @a indices is the array containing @a count index data elements.
 	virtual IndexBufferId	create_index_buffer(size_t count, const void* indices) = 0;
 	virtual IndexBufferId	create_index_buffer(size_t count, const void* indices) = 0;
 
 
-	/// Destroys the @id index buffer.
+	/// Destroys the @a id index buffer.
 	virtual void			destroy_index_buffer(IndexBufferId id) = 0;
 	virtual void			destroy_index_buffer(IndexBufferId id) = 0;
 
 
 	virtual TextureId		create_texture(uint32_t width, uint32_t height, PixelFormat format, const void* data) = 0;
 	virtual TextureId		create_texture(uint32_t width, uint32_t height, PixelFormat format, const void* data) = 0;
@@ -124,22 +124,22 @@ public:
 	/// Sets whether lighting is enabled.
 	/// Sets whether lighting is enabled.
 	virtual void			set_lighting(bool lighting) = 0;
 	virtual void			set_lighting(bool lighting) = 0;
 
 
-	/// Sets the global ambient light @color.
+	/// Sets the global ambient light @a color.
 	virtual void			set_ambient_light(const Color4& color) = 0;
 	virtual void			set_ambient_light(const Color4& color) = 0;
 
 
 	//! Sets the texture to use in the specified layer
 	//! Sets the texture to use in the specified layer
 	virtual void			bind_texture(uint32_t layer, TextureId texture) = 0;
 	virtual void			bind_texture(uint32_t layer, TextureId texture) = 0;
 
 
-	/// Set whether the given texture @unit is enabled.
+	/// Set whether the given texture @a unit is enabled.
 	virtual void			set_texturing(uint32_t unit, bool texturing) = 0;
 	virtual void			set_texturing(uint32_t unit, bool texturing) = 0;
 
 
-	/// Sets the texture @mode for the given texture @unit.
+	/// Sets the texture @a mode for the given texture @a unit.
 	virtual void			set_texture_mode(uint32_t unit, TextureMode mode, const Color4& blendColor) = 0;
 	virtual void			set_texture_mode(uint32_t unit, TextureMode mode, const Color4& blendColor) = 0;
 
 
-	/// Sets the texture @wrap parameter for the given texture @unit.
+	/// Sets the texture @a wrap parameter for the given texture @a unit.
 	virtual void			set_texture_wrap(uint32_t unit, TextureWrap wrap) = 0;
 	virtual void			set_texture_wrap(uint32_t unit, TextureWrap wrap) = 0;
 
 
-	/// Sets the @filter for the given texture @unit.
+	/// Sets the @a filter for the given texture @a unit.
 	virtual void			set_texture_filter(uint32_t unit, TextureFilter filter) = 0;
 	virtual void			set_texture_filter(uint32_t unit, TextureFilter filter) = 0;
 
 
 	virtual void			set_light(uint32_t light, bool active) = 0;
 	virtual void			set_light(uint32_t light, bool active) = 0;

+ 2 - 2
src/renderers/VertexFormat.h

@@ -48,10 +48,10 @@ class Vertex
 {
 {
 public:
 public:
 
 
-	/// Returns the bytes occupied by @format
+	/// Returns the bytes occupied by @a format
 	static size_t bytes_per_vertex(VertexFormat format);
 	static size_t bytes_per_vertex(VertexFormat format);
 
 
-	/// Returns the bits occupied by @format
+	/// Returns the bits occupied by @a format
 	static size_t bits_per_vertex(VertexFormat format);
 	static size_t bits_per_vertex(VertexFormat format);
 
 
 private:
 private:

+ 7 - 7
tools/editors/world-editor/terrain/Heightfield.h

@@ -39,12 +39,12 @@ public:
 				Heightfield();
 				Heightfield();
 				~Heightfield();
 				~Heightfield();
 
 
-	/// (Re)Creates the heightfield of sizes @width by @height.
-	/// The param @meters_per_tile indicates how many meters should be mapped per tile unit. (Higher values
-	///	means better quality at same sizes. You can also specify an @initial_height for all the tiles of the heightmap.
+	/// (Re)Creates the heightfield of sizes @a width by @a height.
+	/// The param @a meters_per_tile indicates how many meters should be mapped per tile unit. (Higher values
+	///	means better quality at same sizes. You can also specify an @a initial_height for all the tiles of the heightmap.
 	void		recreate(uint32_t width, uint32_t height, uint32_t meters_per_tile, float initial_altitude, float min_altitude, float max_altitude);
 	void		recreate(uint32_t width, uint32_t height, uint32_t meters_per_tile, float initial_altitude, float min_altitude, float max_altitude);
 
 
-	/// Clears the content of the heightfield, switching it to the initial parameters passed to @recreate().
+	/// Clears the content of the heightfield, switching it to the initial parameters passed to @a recreate().
 	void		clear();
 	void		clear();
 
 
 	uint32_t	width() const;
 	uint32_t	width() const;
@@ -56,13 +56,13 @@ public:
 	void		set_min_altitude(float min);
 	void		set_min_altitude(float min);
 	void		set_max_altitude(float max);
 	void		set_max_altitude(float max);
 
 
-	/// Returns the altitude value for the tile at @x and @y coordinates.
+	/// Returns the altitude value for the tile at @a x and @a y coordinates.
 	float		altitude(uint32_t x, uint32_t y) const;
 	float		altitude(uint32_t x, uint32_t y) const;
 
 
-	/// Sets the @height value for the tile @x and @y coordinates.
+	/// Sets the @a height value for the tile @a x and @a y coordinates.
 	void		set_altitude(uint32_t x, uint32_t y, float altitude);
 	void		set_altitude(uint32_t x, uint32_t y, float altitude);
 
 
-	/// Sets the @height value for all the tiles.
+	/// Sets the @a height value for all the tiles.
 	void		set_altitudes(float altitude);
 	void		set_altitudes(float altitude);
 
 
 private:
 private: