# doxygen to hide any special comment blocks from generated source code
# fragments. Normal C and C++ comments will always remain visible.
-STRIP_CODE_COMMENTS = NO
+STRIP_CODE_COMMENTS = YES
# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
# file names in lower case letters. If set to YES upper case letters are also
# comments will behave just like the Qt-style comments (thus requiring an
# explict @brief command for a brief description.
-JAVADOC_AUTOBRIEF = NO
+JAVADOC_AUTOBRIEF = YES
# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
# member inherits the documentation from any documented member that it
# and *.h) to filter out the source-files in the directories. If left
# blank all files are included.
-FILE_PATTERNS = *.cpp *.h
+FILE_PATTERNS = *.cpp *.h *.doc
# The RECURSIVE tag can be used to turn specify whether or not subdirectories
# should be searched for input files as well. Possible values are YES and NO.
# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
# generate HTML output.
-GENERATE_HTML = YES
+GENERATE_HTML = NO
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
# by the printer. Possible values are: a4, a4wide, letter, legal and
# executive. If left blank a4wide will be used.
-PAPER_TYPE = a4wide
+PAPER_TYPE = a4
# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
# packages that should be included in the LaTeX output.
# plain latex in the generated Makefile. Set this option to YES to get a
# higher quality PDF documentation.
-USE_PDFLATEX = NO
+USE_PDFLATEX = YES
# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
# command to the generated LaTeX files. This will instruct LaTeX to keep
# The TAGFILES tag can be used to specify one or more tagfiles.
-TAGFILES = /home/whale/www/html/d/qtdox/qt.doxtag=/home/whale/www/html/d/qtdox/html
+TAGFILES = /home/whale/www/d/qtdox/qt.doxtag=/home/whale/www/d/qtdox/html
# When a file name is specified after GENERATE_TAGFILE, doxygen will create
# a tag file that is based on the input files it reads.
*/
int initiative() const;
- /** Sets the agility, the higher it is the harder it is to hit the unit */
+ /** Used to set the agility, the higher it is the harder it is to hit the unit
+ * \param iAgil the agility represnted as an int
+ */
void setAgility (int iAgil);
+ /** used to get this unittype's agility, higher is equal to hard to hit.
+ * \returns the agility as an int
+ */
int agility() const;
- /** Sets the weaponspeed.. just a simple integer that shows how good it is at hitting things */
+ /** Used to set the weaponspeed.. Higher is equal to better at hitting
+ * \param iWPSP the weaponspeed represented as an int.
+ */
void setWeaponSpeed(int iWPSP);
+ /** Used to get what weaponspeed this unittype has
+ * \returns the weaponspeed as an int
+ */
int weaponSpeed() const;
- /** Sets the number of guns. */
+ /** Sets the number of guns for this unittype
+ * \param iGuns the number of guns represented as an int
+ */
void setGuns(int iGuns);
+ /** used to get the number of guns this unittype has
+ * \returns the number of guns as an int
+ */
int guns() const;
/** Sets the how much power the guns have.. or in other words: the damage they do. */