Skip to content

Commit a436849

Browse files
committed
fix: added missing @brief
1 parent afb2b7a commit a436849

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

others/serialization.cpp

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -55,11 +55,11 @@ class Serializer {
5555
}
5656

5757
/**
58-
* Serializes a string to a binary file.
58+
* @brief Serializes a string to a binary file.
5959
* @param out The output stream (std::ofstream).
6060
* @param data The string to be serialized.
6161
*
62-
* The string is serialized by first storing its length, followed by the
62+
* @note The string is serialized by first storing its length, followed by the
6363
* content.
6464
*/
6565
static void serialize(std::ofstream &out, const std::string &data) {
@@ -77,7 +77,7 @@ class Serializer {
7777
class Deserializer {
7878
public:
7979
/**
80-
* Deserializes fundamental data types (like int, float, double, etc.) from
80+
* @brief Deserializes fundamental data types (like int, float, double, etc.) from
8181
* a binary file.
8282
* @tparam T The type of the data to be deserialized.
8383
* @param in The input stream (std::ifstream).
@@ -94,7 +94,7 @@ class Deserializer {
9494
}
9595

9696
/**
97-
* Deserializes a string from a binary file.
97+
* @brief Deserializes a string from a binary file.
9898
* @param in The input stream (std::ifstream).
9999
* @param data The string where the deserialized content will be stored.
100100
*

0 commit comments

Comments
 (0)