From eb299736c1bcb277da1862afe95c11cb897effcf Mon Sep 17 00:00:00 2001 From: rubidium Date: Sat, 22 Jan 2011 09:53:15 +0000 Subject: (svn r21886) -Codechange: move documentation towards the code to make it more likely to be updated [n]. --- src/spriteloader/grf.hpp | 4 +--- src/spriteloader/png.hpp | 4 +--- src/spriteloader/spriteloader.hpp | 5 +++++ 3 files changed, 7 insertions(+), 6 deletions(-) (limited to 'src/spriteloader') diff --git a/src/spriteloader/grf.hpp b/src/spriteloader/grf.hpp index 07d89c3f9..be41cfd06 100644 --- a/src/spriteloader/grf.hpp +++ b/src/spriteloader/grf.hpp @@ -14,11 +14,9 @@ #include "spriteloader.hpp" +/** Sprite loader for graphics coming from a (New)GRF. */ class SpriteLoaderGrf : public SpriteLoader { public: - /** - * Load a sprite from the disk and return a sprite struct which is the same for all loaders. - */ bool LoadSprite(SpriteLoader::Sprite *sprite, uint8 file_slot, size_t file_pos, SpriteType sprite_type); }; diff --git a/src/spriteloader/png.hpp b/src/spriteloader/png.hpp index 2cb5d1dde..55f733e63 100644 --- a/src/spriteloader/png.hpp +++ b/src/spriteloader/png.hpp @@ -14,11 +14,9 @@ #include "spriteloader.hpp" +/** Sprite loader for graphics coming from a PNG image. */ class SpriteLoaderPNG : public SpriteLoader { public: - /** - * Load a sprite from the disk and return a sprite struct which is the same for all loaders. - */ bool LoadSprite(SpriteLoader::Sprite *sprite, uint8 file_slot, size_t file_pos, SpriteType sprite_type); }; diff --git a/src/spriteloader/spriteloader.hpp b/src/spriteloader/spriteloader.hpp index 693c85329..b159c95a4 100644 --- a/src/spriteloader/spriteloader.hpp +++ b/src/spriteloader/spriteloader.hpp @@ -50,6 +50,11 @@ public: /** * Load a sprite from the disk and return a sprite struct which is the same for all loaders. + * @param sprite The sprite to fill with data. + * @param file_slot The file "descriptor" of the file we read from. + * @param file_pos The position within the file the image begins. + * @param sprite_type The type of sprite we're trying to load. + * @return true iff loading went okay. */ virtual bool LoadSprite(SpriteLoader::Sprite *sprite, uint8 file_slot, size_t file_pos, SpriteType sprite_type) = 0; -- cgit v1.2.3-70-g09d2