documentation

diff --git a/bs/docs/api/hbs.doxconf b/bs/docs/api/hbs.doxconf
index 8b3fc7256b54fd3a0d9d4ef4c974db2b6e90009b..3250a6bb6f84ca75d12225395a87cc108f53d33e 100644 (file)
--- a/bs/docs/api/hbs.doxconf
+++ b/bs/docs/api/hbs.doxconf
@@ -134,7 +134,7 @@ INLINE_SOURCES         = NO
 # doxygen to hide any special comment blocks from generated source code 
 # fragments. Normal C and C++ comments will always remain visible.
 
 # 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 
 
 # 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 


@@ -174,7 +174,7 @@ SHOW_INCLUDE_FILES     = YES
 # comments  will behave just like the Qt-style comments (thus requiring an 
 # explict @brief command for a brief description.
 
 # 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 
 
 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented 
 # member inherits the documentation from any documented member that it 


@@ -311,7 +311,7 @@ INPUT                  = ../../
 # and *.h) to filter out the source-files in the directories. If left 
 # blank all files are included.
 
 # 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. 
 
 # 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. 


@@ -395,7 +395,7 @@ IGNORE_PREFIX          =
 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will 
 # generate HTML output.
 
 # 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 
 
 # 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 


@@ -502,7 +502,7 @@ COMPACT_LATEX          = NO
 # by the printer. Possible values are: a4, a4wide, letter, legal and 
 # executive. If left blank a4wide will be used.
 
 # 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.
 
 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX 
 # packages that should be included in the LaTeX output.


@@ -527,7 +527,7 @@ PDF_HYPERLINKS         = NO
 # plain latex in the generated Makefile. Set this option to YES to get a 
 # higher quality PDF documentation.
 
 # 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 
 
 # 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 


@@ -680,7 +680,7 @@ EXPAND_AS_DEFINED      =
 
 # The TAGFILES tag can be used to specify one or more tagfiles.
 
 
 # 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.
 
 # When a file name is specified after GENERATE_TAGFILE, doxygen will create 
 # a tag file that is based on the input files it reads.

diff --git a/bs/unittype.h b/bs/unittype.h
index 895b03de4595fbaaaf559f516cd095a59392be6e..b01de80ef3c247107bfd3fb6b7c601aeef1a3f6f 100644 (file)
--- a/bs/unittype.h
+++ b/bs/unittype.h
@@ -94,16 +94,31 @@ public:
         */
        int      initiative() const;
 
         */
        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);
        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;
 
        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);
        void setWeaponSpeed(int iWPSP);

+       /** Used to get what weaponspeed this unittype has
+        * \returns the weaponspeed as an int
+        */

        int  weaponSpeed() const;
 
        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);
        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. */
        int guns() const;
 
        /** Sets the how much power the guns have.. or in other words: the damage they do. */