diff options
| author | Ben Boeckel <MathStuf@gmail.com> | 2009-01-17 12:38:16 -0500 |
|---|---|---|
| committer | Ben Boeckel <MathStuf@gmail.com> | 2009-01-17 12:38:16 -0500 |
| commit | 8ffb537df009f80bb5448fec8c2265caacfa0b6c (patch) | |
| tree | 762f783089c86295cd6e0428da14491df9a74452 | |
| parent | 2ea68783aa82e4be8eabc4bce76625921e67f30d (diff) | |
| download | sigen-8ffb537df009f80bb5448fec8c2265caacfa0b6c.tar.gz sigen-8ffb537df009f80bb5448fec8c2265caacfa0b6c.tar.xz sigen-8ffb537df009f80bb5448fec8c2265caacfa0b6c.zip | |
Minor consistency changes with documentation
| -rw-r--r-- | sigmod/Author.h | 8 | ||||
| -rw-r--r-- | sigmod/Badge.h | 10 | ||||
| -rw-r--r-- | sigmod/CoinList.h | 4 | ||||
| -rw-r--r-- | sigmod/CoinListItem.h | 8 | ||||
| -rw-r--r-- | sigmod/Item.h | 6 |
5 files changed, 18 insertions, 18 deletions
diff --git a/sigmod/Author.h b/sigmod/Author.h index e3e2d2a4..3d37bd44 100644 --- a/sigmod/Author.h +++ b/sigmod/Author.h @@ -1,5 +1,5 @@ /* - * Copyright 2007-2008 Ben Boeckel <MathStuf@gmail.com> + * Copyright 2007-2009 Ben Boeckel <MathStuf@gmail.com> * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by @@ -90,19 +90,19 @@ class SIGMOD_EXPORT Author : public Object QDomElement save() const; /** - * Set the name of the author. + * Sets the name of the author. * * \param name The name of the author. */ void setName(const QString& name); /** - * Set the email of the author. It is not checked to be well-formed until the author is \link Author::validate \p validated \endlink. + * Sets the email of the author. It is not checked to be well-formed until the author is \link Author::validate \p validated \endlink. * * \param email The email of the author. */ void setEmail(const QString& email); /** - * Set what the author did for the sigmod. The default credits generator assumes that the roles are comma-separated. + * Sets what the author did for the sigmod. The default credits generator assumes that the roles are comma-separated. * * \param role The role(s) of the author. */ diff --git a/sigmod/Badge.h b/sigmod/Badge.h index eaee1667..455f7703 100644 --- a/sigmod/Badge.h +++ b/sigmod/Badge.h @@ -1,5 +1,5 @@ /* - * Copyright 2007-2008 Ben Boeckel <MathStuf@gmail.com> + * Copyright 2007-2009 Ben Boeckel <MathStuf@gmail.com> * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by @@ -100,26 +100,26 @@ class SIGMOD_EXPORT Badge : public Object */ void setName(const QString& name); /** - * Set the \p id of the sprite that is to be used for the badge before it is obtained. + * Sets the \p id of the sprite that is to be used for the badge before it is obtained. * * \param face The \p id of the sprite to be used before the badge is obtained. */ void setFace(const int face); /** - * Set the \p id of the sprite that is to be used for the badge once it is obtained. + * Sets the \p id of the sprite that is to be used for the badge once it is obtained. * * \param badge The \p id of the sprite to be used after the badge is obtained. */ void setBadge(const int badge); /** - * Set the maximum level at which team members of the player are guaranteed to obey the player. + * Sets the maximum level at which team members of the player are guaranteed to obey the player. * Above this level, team members may not necessarily obey its trainer. * * \param obey The maximum level that is guaranteed to obey the player once the badge is obtained. */ void setObey(const int obey); /** - * Set a multiplier for a stat once the badge is obtained. + * Sets a multiplier for a stat once the badge is obtained. * * \param stat The stat to set the multiplier for. * \param multiplier The multiplier for the stat once the badge is obtained. diff --git a/sigmod/CoinList.h b/sigmod/CoinList.h index f84d339c..d4864900 100644 --- a/sigmod/CoinList.h +++ b/sigmod/CoinList.h @@ -1,5 +1,5 @@ /* - * Copyright 2007-2008 Ben Boeckel <MathStuf@gmail.com> + * Copyright 2007-2009 Ben Boeckel <MathStuf@gmail.com> * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by @@ -104,7 +104,7 @@ class SIGMOD_EXPORT CoinList : public Object QDomElement save() const; /** - * The name of the coin list. This is only used internally. + * Sets the name of the coin list. This is only used internally. * * \param name The name of the coin list. */ diff --git a/sigmod/CoinListItem.h b/sigmod/CoinListItem.h index c38a7b4b..af18a09e 100644 --- a/sigmod/CoinListItem.h +++ b/sigmod/CoinListItem.h @@ -1,5 +1,5 @@ /* - * Copyright 2007-2008 Ben Boeckel <MathStuf@gmail.com> + * Copyright 2007-2009 Ben Boeckel <MathStuf@gmail.com> * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by @@ -104,19 +104,19 @@ class SIGMOD_EXPORT CoinListItem : public Object QDomElement save() const; /** - * The type of object contained in the item. + * Sets the type of object contained in the item. * * \param type The type of the item. */ void setType(const Type type); /** - * The \p id of the object in the item. + * Sets the \p id of the object in the item. * * \param object The \p id of the object contained in the item. */ void setObject(const int object); /** - * How many coins the item costs. + * Sets how many coins the item costs. * * \param cost How many coins the item costs. */ diff --git a/sigmod/Item.h b/sigmod/Item.h index 120b6166..7733502e 100644 --- a/sigmod/Item.h +++ b/sigmod/Item.h @@ -1,5 +1,5 @@ /* - * Copyright 2007-2008 Ben Boeckel <MathStuf@gmail.com> + * Copyright 2007-2009 Ben Boeckel <MathStuf@gmail.com> * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by @@ -131,13 +131,13 @@ class SIGMOD_EXPORT Item : public Object */ void setWeight(const int weight); /** - * Set the description of the item. It should be describe the item to the player. + * Sets the description of the item. It should be describe the item to the player. * * \param description The description of the item. */ void setDescription(const QString& description); /** - * Set the script that determines the behavior of the item. The following objects are available to the script: + * Sets the script that determines the behavior of the item. The following objects are available to the script: * * - \b owner -- The \link Sigencore::TeamMember team member \endlink which owns the instance of the ability. * - \b client -- The \link Sigencore::Client client \endlink which owns \b owner. |
