[gnome-commander/googletest] Adds comments for doxygen



commit d6ab5c5ae865929c47e3db32a3b56a8f4e1d52dd
Author: Uwe Scholz <uwescholz src gnome org>
Date:   Sat Oct 31 21:24:38 2015 +0100

    Adds comments for doxygen

 tests/gcmd_tests_main.cc |   25 ++++++++++++++++++++++++-
 tests/iv_bm_byte_test.cc |   10 ++++++++--
 tests/iv_bm_byte_test.h  |    8 +++++---
 tests/iv_fileops_test.cc |    4 ++--
 tests/iv_fileops_test.h  |    4 ++--
 5 files changed, 41 insertions(+), 10 deletions(-)
---
diff --git a/tests/gcmd_tests_main.cc b/tests/gcmd_tests_main.cc
index 4483c91..55cbffe 100644
--- a/tests/gcmd_tests_main.cc
+++ b/tests/gcmd_tests_main.cc
@@ -1,4 +1,27 @@
-#include "gtest/gtest.h"
+/**
+ * @file gcmd_tests_main.cc
+ * @brief Part of GNOME Commander - A GNOME based file manager
+ *
+ * @copyright (C) 2006 Assaf Gordon\n
+ * @copyright (C) 2007-2012 Piotr Eljasiak\n
+ * @copyright (C) 2013-2015 Uwe Scholz\n
+ *
+ * @copyright 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
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * @copyright This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * @copyright You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.
+ */
+
+ #include "gtest/gtest.h"
 
 int main(int argc, char **argv) {
   ::testing::InitGoogleTest(&argc, argv);
diff --git a/tests/iv_bm_byte_test.cc b/tests/iv_bm_byte_test.cc
index dfa8848..27662b5 100644
--- a/tests/iv_bm_byte_test.cc
+++ b/tests/iv_bm_byte_test.cc
@@ -1,7 +1,13 @@
-/*
+/**
  * @file iv_bm_byte_test.cc
  * @brief Part of GNOME Commander - A GNOME based file manager
- * 
+ *
+ * @details In this file all tests are placed which belong to the
+ * Boyer–Moore string search algorithm, used in the internal viewer of
+ * GCMD. Currently, only a single test is implemented in which a short
+ * pattern of integers is searched inside a bigger array of integers
+ * (see definitions in @link BmByteTest @endlink).
+ *
  * @copyright (C) 2006 Assaf Gordon\n
  * @copyright (C) 2007-2012 Piotr Eljasiak\n
  * @copyright (C) 2013-2015 Uwe Scholz\n
diff --git a/tests/iv_bm_byte_test.h b/tests/iv_bm_byte_test.h
index d9cab8a..99bc151 100644
--- a/tests/iv_bm_byte_test.h
+++ b/tests/iv_bm_byte_test.h
@@ -1,7 +1,7 @@
-/*
+/**
  * @file iv_bm_byte_test.h
  * @brief Part of GNOME Commander - A GNOME based file manager
- * 
+ *
  * @copyright (C) 2006 Assaf Gordon\n
  * @copyright (C) 2007-2012 Piotr Eljasiak\n
  * @copyright (C) 2013-2015 Uwe Scholz\n
@@ -27,7 +27,9 @@
 #include <intviewer/bm_byte.h>
 #include <intviewer/gvtypes.h>
 
-// The fixture for testing class BmByteTest.
+/**
+ *  The fixture for testing class BmByteTest.
+ */
 class BmByteTest : public ::testing::Test {
   public:
     BmByteTest() : pattern{0x01, 0x04, 0xB4, 0xFE, 0x01, 0x01, 0x04},
diff --git a/tests/iv_fileops_test.cc b/tests/iv_fileops_test.cc
index 32e2fbf..dbc7b7e 100644
--- a/tests/iv_fileops_test.cc
+++ b/tests/iv_fileops_test.cc
@@ -1,7 +1,7 @@
-/*
+/**
  * @file iv_fileops_test.cc
  * @brief Part of GNOME Commander - A GNOME based file manager
- * 
+ *
  * @copyright (C) 2006 Assaf Gordon\n
  * @copyright (C) 2007-2012 Piotr Eljasiak\n
  * @copyright (C) 2013-2015 Uwe Scholz\n
diff --git a/tests/iv_fileops_test.h b/tests/iv_fileops_test.h
index 3a74092..5814cc0 100644
--- a/tests/iv_fileops_test.h
+++ b/tests/iv_fileops_test.h
@@ -1,7 +1,7 @@
-/*
+/**
  * @file iv_fileops_test.h
  * @brief Part of GNOME Commander - A GNOME based file manager
- * 
+ *
  * @copyright (C) 2006 Assaf Gordon\n
  * @copyright (C) 2007-2012 Piotr Eljasiak\n
  * @copyright (C) 2013-2015 Uwe Scholz\n


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]