diff options
| author | Ben Boeckel <MathStuf@gmail.com> | 2008-12-26 02:10:37 -0500 |
|---|---|---|
| committer | Ben Boeckel <MathStuf@gmail.com> | 2008-12-26 02:10:37 -0500 |
| commit | b168c067b0a2e5369ee409da7ba6c6b45bb343d4 (patch) | |
| tree | 950750cdfb786b0cddc9b2e2cea433c806d4e869 | |
| parent | df4ecb40783b24590f45ecb549e325e7a7dbfbb2 (diff) | |
| download | sigen-b168c067b0a2e5369ee409da7ba6c6b45bb343d4.tar.gz sigen-b168c067b0a2e5369ee409da7ba6c6b45bb343d4.tar.xz sigen-b168c067b0a2e5369ee409da7ba6c6b45bb343d4.zip | |
Added descriptions for Item and ItemType
| -rw-r--r-- | sigmod/Item.h | 6 | ||||
| -rw-r--r-- | sigmod/ItemType.h | 2 |
2 files changed, 6 insertions, 2 deletions
diff --git a/sigmod/Item.h b/sigmod/Item.h index 999396a7..59f04675 100644 --- a/sigmod/Item.h +++ b/sigmod/Item.h @@ -35,7 +35,11 @@ class Sigmod; /** * \class Sigmod::Item Item.h sigmod/Item.h - * \brief + * \brief Items are used to objects that can be carried by the player in the game. + * + * Items are carried by the player until used. Items do a wide range of things from + * healing to catching to increasing stats (both permanent and temporarily) or to act + * as keys. */ class SIGMOD_EXPORT Item : public Object { diff --git a/sigmod/ItemType.h b/sigmod/ItemType.h index 6481227c..10a71530 100644 --- a/sigmod/ItemType.h +++ b/sigmod/ItemType.h @@ -32,7 +32,7 @@ class Sigmod; /** * \class Sigmod::ItemType ItemType.h sigmod/ItemType.h - * \brief A + * \brief A category for items to be grouped into. Allows limits to be set for groups of items. */ class SIGMOD_EXPORT ItemType : public Object { |