Gary: Symbol renames

[libucw.git] / ucw / config.h

diff --git a/ucw/config.h b/ucw/config.h
index f03572a5b01e845ca5f66f7f2e643fdc9f1c74ed..88168d1a245bf964f356f658c7b0241034a173db 100644 (file)
--- a/ucw/config.h
+++ b/ucw/config.h
@@ -1,7 +1,7 @@
 /*
  *     UCW Library -- Configuration-Dependent Definitions
  *
- *     (c) 1997--2007 Martin Mares <mj@ucw.cz>
+ *     (c) 1997--2012 Martin Mares <mj@ucw.cz>
  *     (c) 2006 Robert Spalek <robert@ucw.cz>
  *
  *     This software may be freely distributed and used according to the terms
@@ -26,22 +26,21 @@
 #include <stddef.h>
 #include <stdint.h>
 
-typedef uint8_t byte;                  /* exactly 8 bits, unsigned */
-typedef uint8_t u8;                    /* exactly 8 bits, unsigned */
-typedef int8_t s8;                     /* exactly 8 bits, signed */
-typedef uint16_t u16;                  /* exactly 16 bits, unsigned */
-typedef int16_t s16;                   /* exactly 16 bits, signed */
-typedef uint32_t u32;                  /* exactly 32 bits, unsigned */
-typedef int32_t s32;                   /* exactly 32 bits, signed */
-typedef uint64_t u64;                  /* exactly 64 bits, unsigned */
-typedef int64_t s64;                   /* exactly 64 bits, signed */
-
-typedef unsigned int uns;              /* at least 32 bits */
-typedef u32 ucw_time_t;                        /* seconds since UNIX epoch */
-typedef s64 timestamp_t;               /* milliseconds since UNIX epoch */
-
-#ifdef CONFIG_LARGE_FILES              /* File positions */
-typedef s64 ucw_off_t;
+typedef uint8_t byte;                  /** Exactly 8 bits, unsigned **/
+typedef uint8_t u8;                    /** Exactly 8 bits, unsigned **/
+typedef int8_t s8;                     /** Exactly 8 bits, signed **/
+typedef uint16_t u16;                  /** Exactly 16 bits, unsigned **/
+typedef int16_t s16;                   /** Exactly 16 bits, signed **/
+typedef uint32_t u32;                  /** Exactly 32 bits, unsigned **/
+typedef int32_t s32;                   /** Exactly 32 bits, signed **/
+typedef uint64_t u64;                  /** Exactly 64 bits, unsigned **/
+typedef int64_t s64;                   /** Exactly 64 bits, signed **/
+
+typedef unsigned int uns;              /** A better pronounceable alias for `unsigned int` **/
+typedef s64 timestamp_t;               /** Milliseconds since an unknown epoch **/
+
+#ifdef CONFIG_UCW_LARGE_FILES
+typedef s64 ucw_off_t;                 /** File position (either 32- or 64-bit, depending on `CONFIG_UCW_LARGE_FILES`). **/
 #else
 typedef s32 ucw_off_t;
 #endif