diff options
| author | Ben Boeckel <MathStuf@gmail.com> | 2009-01-17 12:48:36 -0500 |
|---|---|---|
| committer | Ben Boeckel <MathStuf@gmail.com> | 2009-01-17 12:48:36 -0500 |
| commit | 4e246b3157dd0f0ef2a309ede75c4d3925fb870e (patch) | |
| tree | 2b6907133bcbfe577d153b9a5372a42096882ca9 | |
| parent | 90a58741db511b19d575e6b82761c7170ad5f2c8 (diff) | |
| download | sigen-4e246b3157dd0f0ef2a309ede75c4d3925fb870e.tar.gz sigen-4e246b3157dd0f0ef2a309ede75c4d3925fb870e.tar.xz sigen-4e246b3157dd0f0ef2a309ede75c4d3925fb870e.zip | |
More minor documentation consistency fixes
| -rw-r--r-- | sigmod/Time.h | 8 | ||||
| -rw-r--r-- | sigmod/Type.h | 2 | ||||
| -rw-r--r-- | sigmod/Weather.h | 4 |
3 files changed, 9 insertions, 5 deletions
diff --git a/sigmod/Time.h b/sigmod/Time.h index 57d13763..fec721b0 100644 --- a/sigmod/Time.h +++ b/sigmod/Time.h @@ -95,21 +95,25 @@ class SIGMOD_EXPORT Time : public Object QDomElement save() const; /** - * The name of the time. Used internally only. + * Sets the name of the time. Used internally only. * * \param name The name of the time. */ void setName(const QString& name); /** + * Sets the hour that the time starts at. + * * \param hour The hour the time starts at. */ void setHour(const int hour); /** + * Sets the minute that the time starts at. + * * \param minutes The minute the time starts at. */ void setMinute(const int minutes); /** - * Set the script executed when the time starts. The following objects are available to the script: + * Sets the script executed when the time starts. The following objects are available to the script: * * - \b sigmod -- The \link Sigscript::SigmodWrapper wrapper \endlink for the \link Sigmod sigmod \endlink in use. * - \b arena -- The \link Sigencore::Arena arena \endlink the ability is being used in (if in battle). diff --git a/sigmod/Type.h b/sigmod/Type.h index 0744f288..dcebd526 100644 --- a/sigmod/Type.h +++ b/sigmod/Type.h @@ -94,7 +94,7 @@ class SIGMOD_EXPORT Type : public Object QDomElement save() const; /** - * The name of the type. + * Sets the name of the type. * * \param name The name of the type. */ diff --git a/sigmod/Weather.h b/sigmod/Weather.h index bfce8a47..dff69ab3 100644 --- a/sigmod/Weather.h +++ b/sigmod/Weather.h @@ -94,13 +94,13 @@ class SIGMOD_EXPORT Weather : public Object QDomElement save() const; /** - * The name of the weather. + * Sets the name of the weather. * * \param name The name of the weather. */ void setName(const QString& name); /** - * Set the script for the weather. What the weather does is defined by this script. + * Sets the script for the weather. What the weather does is defined by this script. * The following objects are available to the script: * * - \b owner -- The \link Sigencore::TeamMember team member \endlink which owns the instance of the ability. |
