From: Steven R. Loomis <srl@icu-project.org>
Date: Fri, 19 Apr 2013 23:39:07 +0000 (+0000)
Subject: ICU-10107 improve API docs for new function
X-Git-Tag: milestone-59-0-1~2939
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=53d7ea493096b7deffc98a0bd406385bee5bc61f;p=icu

ICU-10107 improve API docs for new function

X-SVN-Rev: 33540
---

diff --git a/icu4c/source/layout/LEFontInstance.h b/icu4c/source/layout/LEFontInstance.h
index d84a652625f..496c7c137a9 100644
--- a/icu4c/source/layout/LEFontInstance.h
+++ b/icu4c/source/layout/LEFontInstance.h
@@ -1,7 +1,7 @@
 
 /*
  *
- * (C) Copyright IBM Corp. 1998-2012 - All Rights Reserved
+ * (C) Copyright IBM Corp. 1998-2013 - All Rights Reserved
  *
  */
 
@@ -156,6 +156,10 @@ public:
      *
      * Subclasses which represent composite fonts should always return <code>NULL</code>.
      *
+     * Note that implementing this function does not allow for range checking. 
+     * Subclasses that desire the safety of range checking must implement the
+     * variation which has a length parameter.
+     *
      * @param tableTag - the four byte table tag. (e.g. 'cmap') 
      *
      * @return the address of the table in memory, or <code>NULL</code>
@@ -175,6 +179,8 @@ public:
      * Subclasses which represent composite fonts should always return <code>NULL</code>.
      * 
      * This version sets a length, for range checking.
+     * Note that range checking can only be accomplished if this function is 
+     * implemented in subclasses.
      *
      * @param tableTag - the four byte table tag. (e.g. 'cmap') 
      * @param length - ignored on entry, on exit will be the length of the table if known, or -1 if unknown.