Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 754b1757 authored by Biswarup Pal's avatar Biswarup Pal
Browse files

Improve javadoc for FRRO dimension overlay APIs 

Added documentation to explain how to use the two APIs for overlaying dimensions with and without units.

Test: presubmit
Bug: 406060192
Flag: EXEMPT documentation improvement
Change-Id: I63489786c0f0ec7b3e3839e9a64e4c4fab4998d8
parent 67d43409

core/java/android/content/om/FabricatedOverlay.java

+7 −3
Original line number Diff line number Diff line
@@ -614,7 +614,7 @@ public class FabricatedOverlay { 


    /**

     * Sets the resource value in the fabricated overlay for the dimension type with the

     * configuration.

     * given configuration.

     *

     * <p>This can be used to overlay dimension resources of the following formats.

     * <pre>
@@ -625,6 +625,8 @@ public class FabricatedOverlay { 
     * &lt;dimen name="foo"&gt;10in&lt;/dimen&gt;

     * &lt;dimen name="foo"&gt;10pt&lt;/dimen&gt;

     * </pre>

     * For overlaying unitless dimension resources, use

     * {@link #setResourceValue(String, float, String)} instead.

     *

     * @param resourceName name of the target resource to overlay (in the form

     *     [package]:type/entry)
@@ -645,12 +647,14 @@ public class FabricatedOverlay { 


    /**

     * Sets the resource value in the fabricated overlay for the float type with the

     * configuration.

     * given configuration.

     *

     * <p>This can be used to overlay float resources of the following format.

     * <p>This can be used to overlay unitless float resources of the following format.

     * <pre>

     * &lt;item name="foo" format="float" type="dimen"&gt;0.015&lt;/item&gt;

     * </pre>

     * For overlaying dimension resources with units, use

     * {@link #setResourceValue(String, float, int, String)} instead.

     *

     * @param resourceName name of the target resource to overlay (in the form

     *     [package]:type/entry)