diff trunk/src/dil/FileBOM.d @ 786:3b34f6a95a27

Added and revised documenation comments.
author Aziz K?ksal <aziz.koeksal@gmail.com>
date Sun, 24 Feb 2008 02:41:11 +0100
parents 164b4ecd9793
children
line wrap: on
line diff
--- a/trunk/src/dil/FileBOM.d	Sat Feb 23 21:15:56 2008 +0100
+++ b/trunk/src/dil/FileBOM.d	Sun Feb 24 02:41:11 2008 +0100
@@ -5,7 +5,7 @@
 module dil.FileBOM;
 import common;
 
-/// Byte Order Mark
+/// Enumeration of byte order marks.
 enum BOM
 {
   None,    /// No BOM
@@ -16,6 +16,7 @@
   UTF32LE  /// UTF-32 Little Endian: FF FE 00 00
 }
 
+/// Looks at the first bytes of data and returns the corresponding BOM.
 BOM tellBOM(ubyte[] data)
 {
   BOM bom = BOM.None;