X-Git-Url: https://git.saurik.com/apple/icu.git/blobdiff_plain/51004dcb01e06fef634b61be77ed73dd61cb6db9..b801cf366c7671a99bdcef84d1e9c0ec64b36723:/icuSources/common/unicode/udata.h

diff --git a/icuSources/common/unicode/udata.h b/icuSources/common/unicode/udata.h
index f9b4cd44..29e46630 100644
--- a/icuSources/common/unicode/udata.h
+++ b/icuSources/common/unicode/udata.h
@@ -1,7 +1,7 @@
 /*
 ******************************************************************************
 *
-*   Copyright (C) 1999-2012, International Business Machines
+*   Copyright (C) 1999-2014, International Business Machines
 *   Corporation and others.  All Rights Reserved.
 *
 ******************************************************************************
@@ -77,6 +77,10 @@ U_CDECL_BEGIN
  * <p>This structure may grow in the future, indicated by the
  * <code>size</code> field.</p>
  *
+ * <p>ICU data must be at least 8-aligned, and should be 16-aligned.
+ * The UDataInfo struct begins 4 bytes after the start of the data item,
+ * so it is 4-aligned.
+ *
  * <p>The platform data property fields help determine if a data
  * file can be efficiently used on a given machine.
  * The particular fields are of importance only if the data
@@ -92,7 +96,7 @@ U_CDECL_BEGIN
  *
  * <p>The <code>formatVersion</code> field should be used to
  * make sure that the format can be interpreted.
- * I may be a good idea to check only for the one or two highest
+ * It may be a good idea to check only for the one or two highest
  * of the version elements to allow the data memory to
  * get more or somewhat rearranged contents, for as long
  * as the using code can still interpret the older contents.</p>
@@ -101,6 +105,7 @@ U_CDECL_BEGIN
  * common place to store the source version of the data;
  * for data from the Unicode character database, this could
  * reflect the Unicode version.</p>
+ *
  * @stable ICU 2.0
  */
 typedef struct {
@@ -279,6 +284,9 @@ U_NAMESPACE_END
 /**
  * Get the pointer to the actual data inside the data memory.
  * The data is read-only.
+ *
+ * ICU data must be at least 8-aligned, and should be 16-aligned.
+ *
  * @param pData The pointer to data memory object
  * @stable ICU 2.0
  */
@@ -311,6 +319,9 @@ udata_getInfo(UDataMemory *pData, UDataInfo *pInfo);
  * allows you to force ICU's system data to come out of a user-specified
  * area in memory.
  *
+ * ICU data must be at least 8-aligned, and should be 16-aligned.
+ * See http://userguide.icu-project.org/icudata
+ *
  * The format of this data is that of the icu common data file, as is
  * generated by the pkgdata tool with mode=common or mode=dll.
  * You can read in a whole common mode file and pass the address to the start of the
@@ -355,6 +366,9 @@ udata_setCommonData(const void *data, UErrorCode *err);
  * data and allows you to force the it to come out of a user-specified
  * pointer.
  *
+ * ICU data must be at least 8-aligned, and should be 16-aligned.
+ * See http://userguide.icu-project.org/icudata
+ *
  * The format of this data is that of the icu common data file, like 'icudt26l.dat'
  * or the corresponding shared library (DLL) file.
  * The application must read in or otherwise construct an image of the data and then