[colobot] 64/100: Minor documentation fixes

[Didier Raboud]

This is an automated email from the git hooks/post-receive script.

odyx pushed a commit to branch debian/master
in repository colobot.

commit b3ea687d327c3779601e2724f31c276e002581e4
Author: krzys-h <krzys_h at interia.pl>
Date:   Fri May 19 20:15:13 2017 +0200

    Minor documentation fixes
---
 Doxyfile.in                               | 2 +-
 src/common/resources/outputstream.h       | 4 ++--
 src/common/resources/outputstreambuffer.h | 2 +-
 src/level/scoreboard.h                    | 2 ++
 4 files changed, 6 insertions(+), 4 deletions(-)

diff --git a/Doxyfile.in b/Doxyfile.in
index 5b0d31f..178001f 100644
--- a/Doxyfile.in
+++ b/Doxyfile.in
@@ -993,7 +993,7 @@ USE_HTAGS              = NO
 # See also: Section \class.
 # The default value is: YES.
 
-VERBATIM_HEADERS       = YES
+VERBATIM_HEADERS       = NO
 
 # If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the
 # clang parser (see: http://clang.llvm.org/) for more accurate parsing at the
diff --git a/src/common/resources/outputstream.h b/src/common/resources/outputstream.h
index c1ac33d..1aeaf74 100644
--- a/src/common/resources/outputstream.h
+++ b/src/common/resources/outputstream.h
@@ -39,7 +39,7 @@ public:
     /** Construct and Open Stream for writing
      *
      * \param filename
-     * \param Mode one of: std::ios_base::out - Open for writing, std::ios_base::app - Append to file
+     * \param mode one of: std::ios_base::out - Open for writing, std::ios_base::app - Append to file
      *
      */
     COutputStream(const std::string& filename, std::ios_base::openmode mode = std::ios_base::out);
@@ -48,7 +48,7 @@ public:
     /** Open Stream for writing
      *
      * \param filename
-     * \param Mode one of: std::ios_base::out - Open for writing, std::ios_base::app - Append to file
+     * \param mode one of: std::ios_base::out - Open for writing, std::ios_base::app - Append to file
      *
      */
     void open(const std::string& filename, std::ios_base::openmode mode = std::ios_base::out);
diff --git a/src/common/resources/outputstreambuffer.h b/src/common/resources/outputstreambuffer.h
index fb7fa53..0945b30 100644
--- a/src/common/resources/outputstreambuffer.h
+++ b/src/common/resources/outputstreambuffer.h
@@ -38,7 +38,7 @@ public:
     /** Open Stream Buffer for writing
      *
      * \param filename
-     * \param Mode one of: std::ios_base::out - Open for writing, std::ios_base::app - Append to file
+     * \param mode one of: std::ios_base::out - Open for writing, std::ios_base::app - Append to file
      *
      */
     void open(const std::string &filename, std::ios_base::openmode mode);
diff --git a/src/level/scoreboard.h b/src/level/scoreboard.h
index 17aa98e..6768a59 100644
--- a/src/level/scoreboard.h
+++ b/src/level/scoreboard.h
@@ -101,7 +101,9 @@ public:
     };
 
 public:
+    //! Add ScoreboardKillRule
     void AddKillRule(std::unique_ptr<CScoreboardKillRule> rule);
+    //! Add ScoreboardEndTakeRule
     void AddEndTakeRule(std::unique_ptr<CScoreboardEndTakeRule> rule);
 
     //! Called after an object is destroyed by another object

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-games/colobot.git