فهرست منبع

Replace @a copydoc with @copydoc

Daniele Bartolini 12 سال پیش
والد
کامیت
5e301b7df8

+ 2 - 2
src/ArchiveBundle.h

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

+ 2 - 2
src/FileBundle.h

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

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

@@ -39,10 +39,10 @@ public:
 				ZipCompressor(Allocator& allocator);
 				ZipCompressor(Allocator& allocator);
 				~ZipCompressor();
 				~ZipCompressor();
 	
 	
-	/// @a copydoc Compressor::compress()
+	/// @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);
 
 
-	/// @a copydoc Compressor::uncompress()
+	/// @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);
 };
 };
 
 

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

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

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

@@ -85,52 +85,52 @@ class MemoryFile: public File
 {
 {
 public:
 public:
 
 
-	/// @a copydoc File::File()
+	/// @copydoc File::File()
 						MemoryFile(MemoryBuffer* buffer, FileOpenMode mode);
 						MemoryFile(MemoryBuffer* buffer, FileOpenMode mode);
 
 
-	/// @a copydoc File::~File()
+	/// @copydoc File::~File()
 	virtual				~MemoryFile();
 	virtual				~MemoryFile();
 
 
-	/// @a copydoc File::seek()
+	/// @copydoc File::seek()
 	void				seek(size_t position);
 	void				seek(size_t position);
 
 
-	/// @a copydoc File::seek_to_end()
+	/// @copydoc File::seek_to_end()
 	void				seek_to_end();
 	void				seek_to_end();
 
 
-	/// @a copydoc File::skip()
+	/// @copydoc File::skip()
 	void				skip(size_t bytes);
 	void				skip(size_t bytes);
 
 
-	/// @a copydoc File::read()
+	/// @copydoc File::read()
 	void				read(void* buffer, size_t size);
 	void				read(void* buffer, size_t size);
 
 
-	/// @a copydoc File::write()
+	/// @copydoc File::write()
 	void				write(const void* buffer, size_t size);
 	void				write(const void* buffer, size_t size);
 
 
-	/// @a copydoc File::copy_to()
+	/// @copydoc File::copy_to()
 	bool				copy_to(File& file, size_t size = 0);
 	bool				copy_to(File& file, size_t size = 0);
 
 
-	/// @a copydoc File::flush()
+	/// @copydoc File::flush()
 	void				flush();
 	void				flush();
 
 
-	/// @a copydoc File::end_of_file()
+	/// @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; }
 
 
-	/// @a copydoc File::is_valid()
+	/// @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(); }
 
 
-	/// @a copydoc File::size()
+	/// @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(); }
 
 
-	/// @a copydoc File::position()
+	/// @copydoc File::position()
 	size_t				position() const { return m_memory_offset; }
 	size_t				position() const { return m_memory_offset; }
 
 
-	/// @a copydoc File::can_read()
+	/// @copydoc File::can_read()
 	bool				can_read() const { return true; }
 	bool				can_read() const { return true; }
 
 
-	/// @a copydoc File::can_write()
+	/// @copydoc File::can_write()
 	bool				can_write() const { return true; }
 	bool				can_write() const { return true; }
 
 
-	/// @a copydoc File::can_seek()
+	/// @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

@@ -38,22 +38,22 @@ class NullFile: public File
 {
 {
 public:
 public:
 
 
-	/// @a copydoc File::File()
+	/// @copydoc File::File()
 				NullFile(FileOpenMode mode) : File(mode) {}
 				NullFile(FileOpenMode mode) : File(mode) {}
 
 
-	/// @a copydoc File::~File()
+	/// @copydoc File::~File()
 	virtual		~NullFile() {}
 	virtual		~NullFile() {}
 
 
-	/// @a copydoc File::seek()
+	/// @copydoc File::seek()
 	void		seek(size_t position) { (void)position; }
 	void		seek(size_t position) { (void)position; }
 
 
-	/// @a copydoc File::seek_to_end()
+	/// @copydoc File::seek_to_end()
 	void		seek_to_end() {}
 	void		seek_to_end() {}
 
 
-	/// @a copydoc File::skip()
+	/// @copydoc File::skip()
 	void		skip(size_t bytes) { (void)bytes; }
 	void		skip(size_t bytes) { (void)bytes; }
 				
 				
-	/// @a copydoc File::read()
+	/// @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)
@@ -64,10 +64,10 @@ public:
 		}
 		}
 	}
 	}
 
 
-	/// @a copydoc File::write()
+	/// @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; }
 
 
-	/// @a copydoc File::copy_to()
+	/// @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)
@@ -77,40 +77,40 @@ public:
 		return true;
 		return true;
 	}
 	}
 
 
-	/// @a copydoc File::flush()
+	/// @copydoc File::flush()
 	void		flush() {};
 	void		flush() {};
 				
 				
-	/// @a copydoc File::is_valid()
+	/// @copydoc File::is_valid()
 	/// @note
 	/// @note
 	///	Returns always true
 	///	Returns always true
 	bool		is_valid() { return true; }
 	bool		is_valid() { return true; }
 				
 				
-	/// @a copydoc File::end_of_file()
+	/// @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; }
 				
 				
-	/// @a copydoc File::size()
+	/// @copydoc File::size()
 	/// @note
 	/// @note
 	///	Returns always 0xFFFFFFFF
 	///	Returns always 0xFFFFFFFF
 	size_t		size() { return ~0; }
 	size_t		size() { return ~0; }
 				
 				
-	/// @a copydoc File::position()
+	/// @copydoc File::position()
 	/// @note
 	/// @note
 	///	Returns always zero
 	///	Returns always zero
 	size_t		position() { return 0; }
 	size_t		position() { return 0; }
 				
 				
-	/// @a copydoc File::can_read()
+	/// @copydoc File::can_read()
 	/// @note
 	/// @note
 	///	Returns always true
 	///	Returns always true
 	bool		can_read() { return true; }
 	bool		can_read() { return true; }
 				
 				
-	/// @a copydoc File::can_write()
+	/// @copydoc File::can_write()
 	/// @note
 	/// @note
 	///	Returns always true
 	///	Returns always true
 	bool		can_write() { return true; }
 	bool		can_write() { return true; }
 				
 				
-	/// @a copydoc File::can_seek()
+	/// @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/mem/LinearAllocator.h

@@ -40,10 +40,10 @@ public:
 				LinearAllocator(void* start, size_t size);
 				LinearAllocator(void* start, size_t size);
 				~LinearAllocator();
 				~LinearAllocator();
 
 
-	/// @a copydoc Allocator::allocate()
+	/// @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);
 
 
-	/// @a copydoc Allocator::deallocate()
+	/// @copydoc Allocator::deallocate()
 	/// @note
 	/// @note
 	/// The linear allocator does not support deallocating
 	/// The linear allocator does not support deallocating
 	/// individual allocations, rather you have to call
 	/// individual allocations, rather you have to call
@@ -53,7 +53,7 @@ public:
 	/// Frees all the allocations made by allocate()
 	/// Frees all the allocations made by allocate()
 	void		clear();
 	void		clear();
 
 
-	/// @a copydoc Allocator::allocated_size()
+	/// @copydoc Allocator::allocated_size()
 	size_t		allocated_size();
 	size_t		allocated_size();
 
 
 private:
 private:

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

@@ -39,13 +39,13 @@ public:
 				MallocAllocator();
 				MallocAllocator();
 				~MallocAllocator();
 				~MallocAllocator();
 
 
-	/// @a copydoc Allocator::allocate()
+	/// @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);
 
 
-	/// @a copydoc Allocator::deallocate()
+	/// @copydoc Allocator::deallocate()
 	void		deallocate(void* data);
 	void		deallocate(void* data);
 
 
-	/// @a copydoc Allocator::allocated_size()
+	/// @copydoc Allocator::allocated_size()
 	size_t		allocated_size();
 	size_t		allocated_size();
 
 
 	/// Returns the size in bytes of the block of memory pointed by @a data
 	/// Returns the size in bytes of the block of memory pointed by @a data

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

@@ -42,10 +42,10 @@ public:
 	/// Tag all allocations made with @a allocator by the given @a 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);
 
 
-	/// @a copydoc Allocator::allocate()
+	/// @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);
 
 
-	/// @a copydoc Allocator::deallocate()
+	/// @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/os/win/WinKeyboard.h

@@ -40,22 +40,22 @@ class WinKeyboard : public Keyboard
 
 
 public:
 public:
 
 
-	/** @a copydoc Keyboard::Keyboard() */
+	/** @copydoc Keyboard::Keyboard() */
 	WinKeyboard(InputManager* creator);
 	WinKeyboard(InputManager* creator);
 
 
-	/** @a copydoc Keyboard::~Keyboard() */
+	/** @copydoc Keyboard::~Keyboard() */
 	~WinKeyboard();
 	~WinKeyboard();
 
 
-	/** @a copydoc Keyboard::IsModifierPressed() */
+	/** @copydoc Keyboard::IsModifierPressed() */
 	virtual bool IsModifierPressed(ModifierKey modifier) const;
 	virtual bool IsModifierPressed(ModifierKey modifier) const;
 
 
-	/** @a copydoc Keyboard::IsKeyPressed() */
+	/** @copydoc Keyboard::IsKeyPressed() */
 	virtual bool IsKeyPressed(KeyCode key) const;
 	virtual bool IsKeyPressed(KeyCode key) const;
 
 
-	/** @a copydoc Keyboard::IsKeyReleased() */
+	/** @copydoc Keyboard::IsKeyReleased() */
 	virtual bool IsKeyReleased(KeyCode key) const;
 	virtual bool IsKeyReleased(KeyCode key) const;
 
 
-	/** @a copydoc Keyboard::EventLoop() */
+	/** @copydoc Keyboard::EventLoop() */
 	virtual void EventLoop();
 	virtual void EventLoop();
 
 
 	/**
 	/**

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

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