X-Git-Url: http://git.pk910.de/?a=blobdiff_plain;f=include%2Ffileio.h;h=a2fcc718afa74523d6a359530ebe3004a954d0ef;hb=refs%2Fheads%2Fupstream;hp=f3c5300079183b3d23944fc4345b2aa2ee5cc6e4;hpb=ae91ef6320f611af74e70a0db2620c338fbaa7d5;p=ircu2.10.12-pk.git

diff --git a/include/fileio.h b/include/fileio.h
index f3c5300..a2fcc71 100644
--- a/include/fileio.h
+++ b/include/fileio.h
@@ -1,7 +1,6 @@
-/*
- * fileio.h
- *
- * $Id$
+/** @file fileio.h
+ * @brief ANSI FILE* clone API declarations.
+ * @version $Id$
  */
 #ifndef INCLUDED_fileio_h
 #define INCLUDED_fileio_h
@@ -13,10 +12,11 @@
 
 struct stat;
 
-/*
- * FileBuf is a mirror of the ANSI FILE struct, but it works for any
+/** A mirror of the ANSI FILE struct, but it works for any
  * file descriptor. FileBufs are allocated when a file is opened with
  * fbopen, and they are freed when the file is closed using fbclose.
+ * (Some OSes limit the range of file descriptors in a FILE*, for
+ * example to fit in "char".)
  */
 typedef struct FileBuf FBFILE;
 
@@ -34,7 +34,7 @@ extern FBFILE *fdbopen(int fd, const char *mode);
  * close a file opened with fbopen, see fclose(3)
  */
 extern void fbclose(FBFILE * fb);
-/* 
+/*
  * return the next character from the file, EOF on end of file
  * see fgetc(3)
  */