fix old doc comments

include/link_or_value.h

@@ -137,10 +137,11 @@ class link_or_value {
     }
 
     /**
-     * @brief todo : write documents much.
-     * @param[in] new_value todo write
-     * @param[out] created_value_ptr todo write
-     * @param[out] old_value todo write
+     * @brief set the new value and release the old value if needed
+     * @param[in] new_value the new value to be set
+     * @param[out] created_value_ptr output parameter filled with the created value pointer
+     * @param[out] old_value output parameter filled with the old value pointer. If caller receives non-null pointer,
+     * it transfers ownership and caller is responsible for deleting the old value pointer.
      */
     void set_value(value* new_value, void** const created_value_ptr,
                    value** old_value = nullptr) {
@@ -174,13 +175,11 @@ class link_or_value {
 private:
     /**
      * @brief A flag for indicating that the next layer exists.
-     *
      */
     static constexpr uintptr_t kChildFlag = 0b10UL << 62UL;
 
     /**
-     * @brief A flag for indicating that the next layer exists.
-     *
+     * @brief A flag for indicating that the value pointer is actually a pointer (i.e. not inlined).
      */
     static constexpr uintptr_t kValPtrFlag = 0b01UL << 62UL;
 

include/thread_info_table.h

@@ -86,9 +86,8 @@ class thread_info_table {
      * the dependency between header files.
      * @tparam border_node Class information is given at compile time to eliminate the
      * dependency between header files.
-     * @param[in] token Session information.
+     * @param[in] token Session information. The behavior is undefined if the @a token is invalid.
      * @return status::OK success.
-     * @return status::WARN_INVALID_TOKEN The @a token of the argument was invalid.
      */
     template<class interior_node, class border_node>
     static status leave_thread_info(Token token) {

include/value.h

@@ -132,8 +132,7 @@ class value {
 
 private:
     /**
-     * @brief A flag for indicating that the next layer exists.
-     *
+     * @brief A flag for indicating that the value pointer is actually a pointer (i.e. not inlined).
      */
     static constexpr uintptr_t kValPtrFlag = 0b01UL << 62UL;