# HG changeset patch
# User Matti Hamalainen <ccr@tnsp.org>
# Date 1579227392 -7200
# Node ID 6d99150a8f89e01aa938b6c3dc9fb025fce28f21
# Parent  badca3de39ea1e2de294e7070cb25f700ddeaad2
Some more slight Doxygenisation.

diff -r badca3de39ea -r 6d99150a8f89 th_args.c
--- a/th_args.c	Fri Jan 17 03:47:19 2020 +0200
+++ b/th_args.c	Fri Jan 17 04:16:32 2020 +0200
@@ -5,8 +5,6 @@
  *
  * Please read file 'COPYING' for information on license and distribution.
  */
-/// @file
-/// @brief Simple commandline argument processing functions
 #include "th_util.h"
 #include "th_args.h"
 #include "th_string.h"
@@ -330,12 +328,15 @@
 
 
 /**
- * Print help for commandline arguments/options
+ * Print neatly formatted help for specified array of commandline options.
+ * The function will attempt to find the best indentation and formatting of
+ * the output using a simple fitting algorithm. Option descriptions will be
+ * automatically split over several lines if necessary.
  * @param fh stdio file handle to output to
  * @param[in] opts options list array
- * @param[in] nopts number of elements in options list array
- * @param[in] flags flags (currently unused)
- * @param[in] width width of the terminal or desired width of the print out
+ * @param[in] nopts number of elements in the options list array @p opts
+ * @param[in] flags (currently unused)
+ * @param[in] width width of the output terminal or the desired maximum width of the printout
  */
 void th_args_help(FILE *fh, const th_optarg *opts,
     const int nopts, const int flags, const int width)
diff -r badca3de39ea -r 6d99150a8f89 th_config.h
--- a/th_config.h	Fri Jan 17 03:47:19 2020 +0200
+++ b/th_config.h	Fri Jan 17 04:16:32 2020 +0200
@@ -5,6 +5,8 @@
  *
  * Please read file 'COPYING' for information on license and distribution.
  */
+/// @file
+/// @brief Configuration file handling functionality.
 #ifndef TH_CONFIG_H
 #define TH_CONFIG_H
 
diff -r badca3de39ea -r 6d99150a8f89 th_endian.h
--- a/th_endian.h	Fri Jan 17 03:47:19 2020 +0200
+++ b/th_endian.h	Fri Jan 17 04:16:32 2020 +0200
@@ -5,6 +5,8 @@
  *
  * Please read file 'COPYING' for information on license and distribution.
  */
+/// @file
+/// @brief Endianess handling functionality for data type conversions, etc.
 #ifndef TH_ENDIAN_H
 #define TH_ENDIAN_H
 
diff -r badca3de39ea -r 6d99150a8f89 th_types.h
--- a/th_types.h	Fri Jan 17 03:47:19 2020 +0200
+++ b/th_types.h	Fri Jan 17 04:16:32 2020 +0200
@@ -4,10 +4,12 @@
  * (C) Copyright 2002-2020 Tecnic Software productions (TNSP)
  *
  * Please read file 'COPYING' for information on license and distribution.
- */
-/* If your code uses "config.h", you need to #include
+ *
+ * If your code uses "config.h", you need to #include
  * it before including this header.
  */
+/// @file
+/// @brief Various platform-specific type and macro definitions.
 #ifndef TH_TYPES_H
 #define TH_TYPES_H 1
 
diff -r badca3de39ea -r 6d99150a8f89 th_util.h
--- a/th_util.h	Fri Jan 17 03:47:19 2020 +0200
+++ b/th_util.h	Fri Jan 17 04:16:32 2020 +0200
@@ -5,6 +5,8 @@
  *
  * Please read file 'COPYING' for information on license and distribution.
  */
+/// @file
+/// @brief Miscellaneous utility functions, memory allocation, error codes etc.
 #ifndef TH_UTIL_H
 #define TH_UTIL_H