am 3f7a4990: Merge "Improve the Resource.getQuantityString/getQuantityText documentation."

* commit '3f7a49904cef7ea14808590b63b115a4381537a1':
  Improve the Resource.getQuantityString/getQuantityText documentation.
This commit is contained in:
Elliott Hughes
2013-03-08 13:59:59 -08:00
committed by Android Git Automerger

View File

@ -232,11 +232,13 @@ public class Resources {
} }
/** /**
* Return the character sequence associated with a particular resource ID for a particular * Returns the character sequence necessary for grammatically correct pluralization
* numerical quantity. * of the given resource ID for the given quantity.
* * Note that the character sequence is selected based solely on grammatical necessity,
* <p>See <a href="{@docRoot}guide/topics/resources/string-resource.html#Plurals">String * and that such rules differ between languages. Do not assume you know which string
* Resources</a> for more on quantity strings. * will be returned for a given quantity. See
* <a href="{@docRoot}guide/topics/resources/string-resource.html#Plurals">String Resources</a>
* for more detail.
* *
* @param id The desired resource identifier, as generated by the aapt * @param id The desired resource identifier, as generated by the aapt
* tool. This integer encodes the package, type, and resource * tool. This integer encodes the package, type, and resource
@ -344,14 +346,17 @@ public class Resources {
} }
/** /**
* Return the string value associated with a particular resource ID for a particular * Formats the string necessary for grammatically correct pluralization
* numerical quantity, substituting the format arguments as defined in * of the given resource ID for the given quantity, using the given arguments.
* {@link java.util.Formatter} and {@link java.lang.String#format}. It will be * Note that the string is selected based solely on grammatical necessity,
* stripped of any styled text information. * and that such rules differ between languages. Do not assume you know which string
* {@more} * will be returned for a given quantity. See
* <a href="{@docRoot}guide/topics/resources/string-resource.html#Plurals">String Resources</a>
* for more detail.
* *
* <p>See <a href="{@docRoot}guide/topics/resources/string-resource.html#Plurals">String * <p>Substitution of format arguments works as if using
* Resources</a> for more on quantity strings. * {@link java.util.Formatter} and {@link java.lang.String#format}.
* The resulting string will be stripped of any styled text information.
* *
* @param id The desired resource identifier, as generated by the aapt * @param id The desired resource identifier, as generated by the aapt
* tool. This integer encodes the package, type, and resource * tool. This integer encodes the package, type, and resource
@ -372,11 +377,13 @@ public class Resources {
} }
/** /**
* Return the string value associated with a particular resource ID for a particular * Returns the string necessary for grammatically correct pluralization
* numerical quantity. * of the given resource ID for the given quantity.
* * Note that the string is selected based solely on grammatical necessity,
* <p>See <a href="{@docRoot}guide/topics/resources/string-resource.html#Plurals">String * and that such rules differ between languages. Do not assume you know which string
* Resources</a> for more on quantity strings. * will be returned for a given quantity. See
* <a href="{@docRoot}guide/topics/resources/string-resource.html#Plurals">String Resources</a>
* for more detail.
* *
* @param id The desired resource identifier, as generated by the aapt * @param id The desired resource identifier, as generated by the aapt
* tool. This integer encodes the package, type, and resource * tool. This integer encodes the package, type, and resource