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

Commit a1bd1712 authored by Joe Fernandez's avatar Joe Fernandez
Browse files

docs: Update RelativeLayout.LayoutParams JavaDoc comments 

Added changes to make purpose/usage of RelativeLayout.LayoutParams more
clear:

- clarify the attributes are set on a view contained in a relative layout
- clarify that relative layout uses these values to position the view
- add note that these values are ignored if view is not contained in a
relative layout
- cross-link code sample in Relative Layout guide
- cross-link guide Layout guide to clarify layout params vs regular
attributes

Test: docs change only. Tested with a docs test build.
Change-Id: I4fe1088594c998cee4ff0b2f6295579956c19d6f
parent 6fba10b0

core/java/android/widget/RelativeLayout.java

+13 −1
Original line number Diff line number Diff line
@@ -1174,7 +1174,19 @@ public class RelativeLayout extends ViewGroup { 
    }



    /**

     * Per-child layout information associated with RelativeLayout.

     * Specifies how a view is positioned within a {@link RelativeLayout}.

     * The relative layout containing the view uses the value of these layout parameters to

     * determine where to position the view on the screen.  If the view is not contained

     * within a relative layout, these attributes are ignored.

     *

     * See the <a href=“https://developer.android.com/guide/topics/ui/layout/relative.html”>

     * Relative Layout</a> guide for example code demonstrating how to use relative layout’s

     * layout parameters in a layout XML.

     *

     * To learn more about layout parameters and how they differ from typical view attributes,

     * see the <a href=“https://developer.android.com/guide/topics/ui/declaring-layout.html#attributes”>

     *     Layouts guide</a>.

     *

     *

     * @attr ref android.R.styleable#RelativeLayout_Layout_layout_alignWithParentIfMissing

     * @attr ref android.R.styleable#RelativeLayout_Layout_layout_toLeftOf