Browse Source

[2094] use \ instead of @ for doxygen commands for consistency.
also, use \brief instead of \short.

JINMEI Tatuya 12 years ago
parent
commit
af5673b049

+ 2 - 2
src/lib/util/unittests/fork.h

@@ -18,8 +18,8 @@
 #include <unistd.h>
 
 /**
- * @file fork.h
- * @short Help functions to fork the test case process.
+ * \file fork.h
+ * \brief Help functions to fork the test case process.
  * Various functions to fork a process and feed some data to pipe, check
  * its output and such lives here.
  */

+ 2 - 2
src/lib/util/unittests/newhook.h

@@ -16,8 +16,8 @@
 #define __UTIL_UNITTESTS_NEWHOOK_H 1
 
 /**
- * @file newhook.h
- * @short Enable the use of special operator new that throws for testing.
+ * \file newhook.h
+ * \brief Enable the use of special operator new that throws for testing.
  *
  * This small utility allows a test case to force the global operator new
  * to throw for a given size to test a case where memory allocation fails

+ 2 - 2
src/lib/util/unittests/testdata.h

@@ -16,8 +16,8 @@
 #define __UTIL_UNITTESTS_TESTDATA_H 1
 
 /**
- * @file testdata.h
- * @short Manipulating test data files.
+ * \file testdata.h
+ * \brief Manipulating test data files.
  *
  * This utility defines functions that help test case handle test data
  * stored in a file.

+ 2 - 2
src/lib/util/unittests/textdata.h

@@ -22,8 +22,8 @@
 #define __UTIL_UNITTESTS_TEXTDATA_H 1
 
 /**
- * @file textdata.h
- * @short Utilities for tests with text data.
+ * \file textdata.h
+ * \brief Utilities for tests with text data.
  *
  * This utility provides convenient helper functions for unit tests using
  * textual data.

+ 2 - 2
src/lib/util/unittests/wiredata.h

@@ -17,8 +17,8 @@
 
 #include <cstddef>
 
-/// @file wiredata.h
-/// @short Utilities for tests with wire data.
+/// \file wiredata.h
+/// \brief Utilities for tests with wire data.
 ///
 /// This utility provides convenient helper functions for unit tests using
 /// wire (binary) data.