From: Tomas Valla <tom@ucw.cz>
Date: Wed, 11 Apr 2012 12:28:49 +0000 (+0200)
Subject: strtonum: Added small bits of documentation
X-Git-Tag: v5.99~163
X-Git-Url: http://mj.ucw.cz/gitweb/?a=commitdiff_plain;h=4045f354d52664be1725f6bc9724e686e807c424;p=libucw.git

strtonum: Added small bits of documentation
---

diff --git a/ucw/strtonum.h b/ucw/strtonum.h
index b16bd29d..865dda7d 100644
--- a/ucw/strtonum.h
+++ b/ucw/strtonum.h
@@ -10,12 +10,13 @@
 #ifndef _STRTONUM_H
 #define _STRTONUM_H
 
+// Set (flags & 0x1f) in the range 1 to 31 to denote the default base of the number
 enum str_to_num_flags {
   STN_SIGNED = 0x20,       // The resulting range is signed
   STN_MINUS = 0x40,        // Allow optional '-' sign
   STN_PLUS = 0x80,         // Allow optional '+' sign
   STN_TRUNC = 0x100,       // Allow range overflow -> truncate to the allowed range
-  STN_DEC = 0x200,         // Support decimal numbers
+  STN_DEC = 0x200,         // Support decimal numbers (currently no prefix)
   STN_HEX = 0x400,         // Support hexadecimal numbers (0x...)
   STN_BIN = 0x800,         // Support binary numbers (0b...)
   STN_OCT = 0x1000,        // Support octal numbers (0o...)