Fastbuf: Rewritten bprintf()

[libucw.git] / ucw / signames.h

diff --git a/ucw/signames.h b/ucw/signames.h
index d7b9cac7bc9ac4e1c336aabd543ef775dce98e48..35996fbd7be758476b316525ff19d45025b5cf64 100644 (file)
--- a/ucw/signames.h
+++ b/ucw/signames.h
@@ -7,8 +7,28 @@
 #ifndef _UCW_SIGNAMES_H
 #define _UCW_SIGNAMES_H
 
+/***
+ * POSIX lacks facilities for conversion between signal names
+ * and signal numbers. They are available in LibUCW, but please
+ * be aware that some signals might be missing on your system.
+ * If they do, please notify LibUCW maintainers.
+ *
+ * The GNU C Library provides `strsignal()` with similar function,
+ * but it returns human-readable strings like "Segmentation fault".
+ ***/
+
+/**
+ * Converts signal name to the corresponding number.
+ * Returns -1 if not found.
+ **/
 int sig_name_to_number(const char *name);
 
+/**
+ * Converts signal number to the corresponding name.
+ * If more names are known for the given signal, one of them
+ * is considered canonical and preferred.
+ * Returns NULL if not found.
+ **/
 const char *sig_number_to_name(int number);
 
 #endif