doxygen

[disorder] / lib / charset.h

diff --git a/lib/charset.h b/lib/charset.h
index 3dcd756c2439e38df8b9cf8bd43c73ea8897b994..f77c58378be2002cc262e0cd85bb8a605d84d479 100644 (file)
--- a/lib/charset.h
+++ b/lib/charset.h
@@ -48,7 +48,12 @@ char *any2any(const char *from/*encoding or 0*/,
  * that iconv knows.  If FROM and TO are both 0 then ANY is returned
  * unchanged. */
 
-
+/** @brief Insist that @p s is not null
+ * @param s Pointer to check
+ * @return @p s
+ *
+ * Terminates the process if @p s is a null pointer.
+ */
 static inline char *nullcheck(char *s) {
   if(!s) exitfn(1);                    /* assume an error already reported */
   return s;
@@ -65,4 +70,3 @@ c-basic-offset:2
 comment-column:40
 End:
 */
-/* arch-tag:ca7783e592109d7b7078175bd301faf7 */