File tree Expand file tree Collapse file tree 1 file changed +5
-5
lines changed Expand file tree Collapse file tree 1 file changed +5
-5
lines changed Original file line number Diff line number Diff line change @@ -273,16 +273,16 @@ namespace qOS {
273273 */
274274 char * integerToString ( signed_t num, char * str, uint8_t base = 10U ) noexcept ;
275275 /* *
276- * @brief Converts a boolean value to a null-terminated string. Input is
277- * considered true with any value different to zero (0).
278- * The argument @a str should be an array long enough to contain the output
279- * @param[in] num Value to be converted to a string.
276+ * @brief Converts a pointer value to a null-terminated string.
277+ * The pointer address is formatted in hexadecimal notation.
278+ * The buffer provided in @a str must be large enough to hold the resulting
279+ * string, including the null terminator.
280+ * @param[in] ptr Pointer value to convert.
280281 * @param[out] str Array in memory where to store the resulting
281282 * null-terminated string.
282283 * @return A pointer to the resulting null-terminated string, same as
283284 * parameter @a str.
284285 */
285-
286286 char * pointerToString ( const void *ptr, char * str ) noexcept ;
287287 char * boolToString ( const bool num, char *str ) noexcept ;
288288
You can’t perform that action at this time.
0 commit comments