docs: complement file comment #18

lymslive · May 9, 2024 · 8989ea7 · 8989ea7
1 parent 69364f5
commit 8989ea7
Show file tree

Hide file tree

Showing 5 changed files with 30 additions and 11 deletions.
diff --git a/include/coutstd.hpp b/include/coutstd.hpp
@@ -1,3 +1,12 @@
+/** 
+ * @file coutstd.hpp
+ * @author lymslive
+ * @date 2024-05-08
+ * @brief Implement the `<<` operator for some of the mose often used
+ * container in `std::`.
+ * @note Required c++11 or above, and the element type in continer should
+ * support `<<` operator.
+ * */
 #ifndef COUTSTD_HPP__
 #define COUTSTD_HPP__
 

diff --git a/include/file-compare.h b/include/file-compare.h
@@ -1,5 +1,5 @@
 /**
- * @file file_compare.h
+ * @file file-compare.h
  * @author lymslive
  * @date 2024-03-25
  * @brief Implement COUT_FILE macro to compare tows text files.

diff --git a/include/tinymain.hpp b/include/tinymain.hpp
@@ -1,10 +1,16 @@
-/// A tiny trival `main` for `tinytast` or `couttast` framework.
-/// May include it into one of and at least one of test case cpp files,
-/// then compile and link it to other test case objects.
-/// Alternative way is link to libtinytast.a or libcouttast, where also include this main.
-/// Note: Can use macro `USE_COUTTAST_FULLIB` to switch to extend `couttast.h`
-/// instead of basic `tinytast.hpp`, but need also link to `libcouttast`
-/// ofcourse.
+/** 
+ * @file tinymain.hpp
+ * @author lymslive
+ * @date 2024-05-08
+ * @brief A tiny trival `main` for `tinytast` or `couttast` framework.
+ * @details 
+ * May include it into one of and at most one of test case cpp files,
+ * then compile and link it to other test case objects.
+ * Alternative way is link to `libtinytast.a` or `libcouttast.a`, where also include this main.
+ * @note Can use macro `USE_COUTTAST_FULLIB` to switch to extend `couttast.h`
+ * instead of basic `tinytast.hpp`, but need also link to `libcouttast.a`
+ * ofcourse.
+ * */
 #ifdef USE_COUTTAST_FULLIB
 
 #include "couttast.h"

diff --git a/include/tinytast.hpp b/include/tinytast.hpp
@@ -1,5 +1,9 @@
-// A very tiny unit test framework with single header even in C++98
-// lymslive @ 2023-06-17 2024-04-17
+/** 
+ * @file tinytast.hpp
+ * @author lymslive
+ * @date 2024-05-08
+ * @brief A very tiny unit test framework with single header even in C++98.
+ * */
 #ifndef TINYTAST_HPP__
 #define TINYTAST_HPP__
 

diff --git a/include/unittast.hpp b/include/unittast.hpp
@@ -1,5 +1,5 @@
 /**
- * @file classtast.hpp
+ * @file unittast.hpp
  * @author lymslive
  * @date 2024-04-25
  * @brief Support group test suite based on file unit or namespace in the file.