(svn r21886) -Codechange: move documentation towards the code to make it more likely to be updated [n].

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);
 };
 

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);
 };
 

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;