Update docs to note that CkArrayIndexMax should be deprecated and removed
authorRamprasad Venkataraman <ramv@illinois.edu>
Wed, 1 Jun 2011 20:50:33 +0000 (15:50 -0500)
committerRamprasad Venkataraman <ramv@illinois.edu>
Wed, 8 Jun 2011 15:37:41 +0000 (10:37 -0500)
src/ck-core/charm++.h

index 187775bb8e9706925f1a153e429698739d75aa3a..ec3c2ccfcc6439f9262532c8c649ec06d72b0c4a 100644 (file)
@@ -319,14 +319,15 @@ class CkArrayIndex
 
 
 /**
- * Support the large body of code that still uses the
- * (now dead) CkArrayIndexMax class to manipulate array
- * indices. All the functionality is now incorporated
- * into the CkArrayIndex base class itself.
+ * Support applications and other charm codes that still use the (now dead)
+ * CkArrayIndexMax class to manipulate array indices. All the functionality is
+ * now incorporated into the CkArrayIndex base class itself.
  *
- * It is recommended that newer code directly use the
- * base class when there is need to handle an array
- * index.
+ * It is recommended that newer code directly use the base class when there is
+ * need to handle an array index.
+ *
+ * @todo: After at least one minor release announcing the deprecation,
+ * CkArrayIndexMax should no longer be supported.
  */
 typedef CkArrayIndex CkArrayIndexMax;