[MN-dev] [mndiff]: r98 - trunk/noe/rs.h

[michael]

Author: michael
Date: Wed Oct 22 00:52:50 2008
New Revision: 98

Log:
Explain sense behind rsTransform().


Modified:
   trunk/noe/rs.h

Modified: trunk/noe/rs.h
==============================================================================
--- trunk/noe/rs.h	(original)
+++ trunk/noe/rs.h	Wed Oct 22 00:52:50 2008
@@ -64,7 +64,8 @@ int EXT(rsDecode)(GFF4Element *data, int
 /**
  * Transforms (or inverse transforms) a Reed Solomon code based on GF(fermat prime) so that
  * none of its parity symbols equals the largest symbol. Both the original and the transformed
- * codes are normal RS codes.
+ * codes are normal RS codes. This transform is usefull as the largest symbol of GF(fermat prime)
+ * does not fit in 16 (or 8 bit).
  * (Possibly) damaged codes should always be corrected through rsDecode() before using this
  * function here!
  * This function/transform needs a data symbol (at tLocation) that is not too large, that