Remove some comments that trip doxygen

Author: ChillerDragon

src/twbl/teeworlds/base/system.h

@@ -35,167 +35,42 @@
 
 int str_length(const char *str);
 
-/*
-	Function: str_timestamp
-		Copies a time stamp in the format year-month-day_hour-minute-second to the string.
-
-	Parameters:
-		buffer - Pointer to a buffer that shall receive the time stamp string.
-		buffer_size - Size of the buffer.
-
-	Remarks:
-		- Guarantees that buffer string will contain zero-termination.
-*/
 void str_timestamp(char *buffer, int buffer_size);
 void str_timestamp_format(char *buffer, int buffer_size, const char *format)
 	GNUC_ATTRIBUTE((format(strftime, 3, 0)));
 void str_timestamp_ex(time_t time, char *buffer, int buffer_size, const char *format)
 	GNUC_ATTRIBUTE((format(strftime, 4, 0)));
 
-/*
-	Function: str_format
-		Performs printf formatting into a buffer.
-
-	Parameters:
-		buffer - Pointer to the buffer to receive the formatted string.
-		buffer_size - Size of the buffer.
-		format - printf formatting string.
-		... - Parameters for the formatting.
-
-	Remarks:
-		- See the C manual for syntax for the printf formatting string.
-		- The strings are treated as zero-termineted strings.
-		- Guarantees that dst string will contain zero-termination.
-*/
 void str_format(char *buffer, int buffer_size, const char *format, ...)
 	GNUC_ATTRIBUTE((format(printf, 3, 4)));
 
-/**
- * Appends a string to another.
- *
- * @ingroup Strings
- *
- * @param dst Pointer to a buffer that contains a string.
- * @param src String to append.
- * @param dst_size Size of the buffer of the dst string.
- *
- * @remark The strings are treated as zero-terminated strings.
- * @remark Guarantees that dst string will contain zero-termination.
- */
 void str_append(char *dst, const char *src, int dst_size);
 
-/**
- * Appends a string to a fixed-size array of chars.
- *
- * @ingroup Strings
- *
- * @param dst Array that shall receive the string.
- * @param src String to append.
- *
- * @remark The strings are treated as zero-terminated strings.
- * @remark Guarantees that dst string will contain zero-termination.
- */
 template<int N>
 void str_append(char (&dst)[N], const char *src)
 {
 	str_append(dst, src, N);
 }
 
-/**
- * Copies a string to another.
- *
- * @ingroup Strings
- *
- * @param dst Pointer to a buffer that shall receive the string.
- * @param src String to be copied.
- * @param dst_size Size of the buffer dst.
- *
- * @return Length of written string, even if it has been truncated
- *
- * @remark The strings are treated as zero-terminated strings.
- * @remark Guarantees that dst string will contain zero-termination.
- */
 void str_copy(char *dst, const char *src, int dst_size);
 
-/**
- * Copies a string to a fixed-size array of chars.
- *
- * @ingroup Strings
- *
- * @param dst Array that shall receive the string.
- * @param src String to be copied.
- *
- * @remark The strings are treated as zero-terminated strings.
- * @remark Guarantees that dst string will contain zero-termination.
- */
 template<int N>
 void str_copy(char (&dst)[N], const char *src)
 {
 	str_copy(dst, src, N);
 }
 
-/**
- * Truncates a string to a given length.
- *
- * @ingroup Strings
- *
- * @param dst Pointer to a buffer that shall receive the string.
- * @param dst_size Size of the buffer dst.
- * @param src String to be truncated.
- * @param truncation_len Maximum length of the returned string (not
- * counting the zero termination).
- *
- * @remark The strings are treated as zero-terminated strings.
- * @remark Guarantees that dst string will contain zero-termination.
- */
 void str_truncate(char *dst, int dst_size, const char *src, int truncation_len);
 
-/*
-	Function: dbg_msg
-
-	Prints a debug message.
-
-	Parameters:
-		sys - A string that describes what system the message belongs to
-		fmt - A printf styled format string.
-
-	See Also:
-		<dbg_assert>
-*/
 void dbg_msg(const char *sys, const char *fmt, ...)
 	GNUC_ATTRIBUTE((format(printf, 2, 3)));
 
 void dbg_break();
 void dbg_assert_imp(const char *filename, int line, bool test, const char *msg);
 
-/* Group: Debug */
-/*
-
-	Function: dbg_assert
-		Breaks into the debugger based on a test.
-
-	Parameters:
-		test - Result of the test.
-		msg - Message that should be printed if the test fails.
-
-	See Also:
-		<dbg_break>
-*/
 void dbg_assert(int test, const char *msg);
 #define dbg_assert(test, msg) dbg_assert_imp(__FILE__, __LINE__, test, msg)
 
-/**
- * @ingroup Debug
- *
- * Breaks into the debugger based on a test.
- *
- * @param test Result of the test.
- * @param msg Message that should be printed if the test fails.
- *
- * @remark Also works in release mode.
- *
- * @see dbg_break
- */
 #define dbg_assert(test, msg) dbg_assert_imp(__FILE__, __LINE__, test, msg)
 void dbg_assert_imp(const char *filename, int line, bool test, const char *msg);
 
@@ -205,18 +80,6 @@ std::wstring windows_utf8_to_wide(const char *str);
 
 int fs_file_time(const char *name, time_t *created, time_t *modified);
 
-/**
- * Checks if a file exists.
- *
- * @ingroup Filesystem
- *
- * @param path the path to check.
- *
- * @return 1 if a file with the given path exists,
- * 0 on failure or if the file does not exist.
- *
- * @remark The strings are treated as zero-terminated strings.
- */
 int fs_is_file(const char *path);
 
 bool str_isnum(char c);