constants.rb in ach_builder-0.2.2

- old
+ new

@@ -1,6 +1,7 @@
 module ACH
+  # This module is a simple namespace for constants used in ACH routines.
   module Constants
     # The length of each record in characters.
     RECORD_SIZE     = 94
     # The file's total record count must be a multiple of this number. The
     # file must be padded with blocking file control records (consisting
@@ -9,13 +10,19 @@
     # Always "1".
     FORMAT_CODE     = 1
     # This character must be used to delimit each row.
     ROWS_DELIMITER  = "\n"
 
+    # ACH defined value of File Header record.
     FILE_HEADER_RECORD_TYPE   = 1
+    # ACH defined value of File Control record.
     FILE_CONTROL_RECORD_TYPE  = 9
+    # ACH defined value of Batch Header record.
     BATCH_HEADER_RECORD_TYPE  = 5
+    # ACH defined value of Batch Entry record.
     BATCH_ENTRY_RECORD_TYPE   = 6
+    # ACH defined value of Batch Addenda record.
     BATCH_ADDENDA_RECORD_TYPE = 7
+    # ACH defined value of Batch Control record.
     BATCH_CONTROL_RECORD_TYPE = 8
   end
-end
\ No newline at end of file
+end