diff options
| author | Bjørn Lindeijer <bjorn@lindeijer.nl> | 2007-01-29 23:07:47 +0000 |
|---|---|---|
| committer | Bjørn Lindeijer <bjorn@lindeijer.nl> | 2007-01-29 23:07:47 +0000 |
| commit | a4e31503633c3029cb6c526275bc34d471a3c0d4 (patch) | |
| tree | bab69782d480aaefb527bc07ad2f9730353a0279 /src/resources | |
| parent | 457ce3e7b4a869f92d8aef31bdee1b6793587a93 (diff) | |
| download | mana-a4e31503633c3029cb6c526275bc34d471a3c0d4.tar.gz mana-a4e31503633c3029cb6c526275bc34d471a3c0d4.tar.bz2 mana-a4e31503633c3029cb6c526275bc34d471a3c0d4.tar.xz mana-a4e31503633c3029cb6c526275bc34d471a3c0d4.zip | |
Some trivial documentation work. Fixes all Doxygen warnings.
Diffstat (limited to 'src/resources')
| -rw-r--r-- | src/resources/image.h | 1 | ||||
| -rw-r--r-- | src/resources/mapreader.h | 5 | ||||
| -rw-r--r-- | src/resources/music.h | 1 | ||||
| -rw-r--r-- | src/resources/soundeffect.h | 1 |
4 files changed, 6 insertions, 2 deletions
diff --git a/src/resources/image.h b/src/resources/image.h index a1ab7f48..03bf0cbc 100644 --- a/src/resources/image.h +++ b/src/resources/image.h @@ -62,6 +62,7 @@ class Image : public Resource * * @param buffer The memory buffer containing the image data. * @param bufferSize The size of the memory buffer in bytes. + * @param idPath The path identifying the resource. * * @return <code>NULL</code> if the an error occurred, a valid pointer * otherwise. diff --git a/src/resources/mapreader.h b/src/resources/mapreader.h index ad21762d..d16ff1d5 100644 --- a/src/resources/mapreader.h +++ b/src/resources/mapreader.h @@ -55,8 +55,9 @@ class MapReader /** * Reads the properties element. * - * @param props the Properties instance to which the properties will - * be assigned + * @param node The <code>properties</code> element. + * @param props The Properties instance to which the properties will + * be assigned. */ static void readProperties(xmlNodePtr node, Properties* props); diff --git a/src/resources/music.h b/src/resources/music.h index 9cf75928..2888eaa0 100644 --- a/src/resources/music.h +++ b/src/resources/music.h @@ -44,6 +44,7 @@ class Music : public Resource * * @param buffer The memory buffer containing the music data. * @param bufferSize The size of the memory buffer in bytes. + * @param idPath The path identifying the resource. * * @return <code>NULL</code> if the an error occurred, a valid pointer * otherwise. diff --git a/src/resources/soundeffect.h b/src/resources/soundeffect.h index 92b0016a..007f5a77 100644 --- a/src/resources/soundeffect.h +++ b/src/resources/soundeffect.h @@ -45,6 +45,7 @@ class SoundEffect : public Resource * * @param buffer The memory buffer containing the sample data. * @param bufferSize The size of the memory buffer in bytes. + * @param idPath The path identifying the resource. * * @return <code>NULL</code> if the an error occurred, a valid pointer * otherwise. |