Make :constraintlayout compatible with Doclava (#244)

Fixes some errors in visibility, documentation or references so that the
library can be processed through Doclava in the jetpack repo.

Co-authored-by: Oscar Adame Vazquez <oscarad@google.com>

Author: oscar-ad

constraintlayout/constraintlayout/src/main/java/androidx/constraintlayout/motion/widget/MotionScene.java

@@ -56,11 +56,9 @@
  * The information to transition between multiple ConstraintSets
  * This Class is meant to be used from XML
  *
- * @hide
  */
-
 public class MotionScene {
-    public static final String TAG = "MotionScene";
+    private static final String TAG = "MotionScene";
     private static final boolean DEBUG = false;
     private static final int MIN_DURATION = 8;
     final static int TRANSITION_BACKWARD = 0;

constraintlayout/constraintlayout/src/main/java/androidx/constraintlayout/utils/widget/ImageFilterButton.java

@@ -270,7 +270,7 @@ public void setImageZoom(float zoom) {
     /**
      * sets the rotation angle of the image in degrees
      *
-     * @rotation the rotation in degrees
+     * @param rotation the rotation in degrees
      */
     public void setImageRotate(float rotation) {
         mRotate = rotation;

constraintlayout/constraintlayout/src/main/java/androidx/constraintlayout/utils/widget/ImageFilterView.java

@@ -395,7 +395,7 @@ public void setImageZoom(float zoom) {
     /**
      * sets the rotation angle of the image in degrees
      *
-     * @rotation the rotation in degrees
+     * @param rotation the rotation in degrees
      */
     public void setImageRotate(float rotation) {
         mRotate = rotation;

constraintlayout/constraintlayout/src/main/java/androidx/constraintlayout/utils/widget/MotionLabel.java

@@ -345,7 +345,7 @@ private float getVerticalOffset() {
     private void setUpTheme(Context context, @Nullable AttributeSet attrs) {
         TypedValue typedValue = new TypedValue();
         final Resources.Theme theme = context.getTheme();
-        theme.resolveAttribute(R.attr.colorPrimary, typedValue, true);
+        theme.resolveAttribute(androidx.appcompat.R.attr.colorPrimary, typedValue, true);
         mPaint.setColor(mTextFillColor = typedValue.data);
     }
 
@@ -612,7 +612,7 @@ private void setTypefaceFromAttrs(String familyName, int typefaceIndex, int styl
         }
     }
 
-    private void setTypeface(Typeface tf) {
+    public void setTypeface(Typeface tf) {
         if (mPaint.getTypeface() != tf) {
             mPaint.setTypeface(tf);
             if (mLayout != null) {

constraintlayout/constraintlayout/src/main/java/androidx/constraintlayout/widget/ConstraintLayout.java

@@ -2433,10 +2433,12 @@ public static class LayoutParams extends ViewGroup.MarginLayoutParams {
          * If the child is the start of a horizontal chain, this attribute will drive how
          * the elements of the chain will be positioned. The possible values are:
          * <ul>
-         * <li>{@see CHAIN_SPREAD} -- the elements will be spread out</li>
-         * <li>{@see CHAIN_SPREAD_INSIDE} -- similar, but the endpoints of the chain will not be spread out</li>
-         * <li>{@see CHAIN_PACKED} -- the elements of the chain will be packed together. The horizontal
-         * bias attribute of the child will then affect the positioning of the packed elements</li>
+         * <li>{@link #CHAIN_SPREAD} -- the elements will be spread out</li>
+         * <li>{@link #CHAIN_SPREAD_INSIDE} -- similar, but the endpoints of the chain will not
+         * be spread out</li>
+         * <li>{@link #CHAIN_PACKED} -- the elements of the chain will be packed together. The
+         * horizontal bias attribute of the child will then affect the positioning of the packed
+         * elements</li>
          * </ul>
          */
         public int horizontalChainStyle = CHAIN_SPREAD;
@@ -2445,36 +2447,44 @@ public static class LayoutParams extends ViewGroup.MarginLayoutParams {
          * If the child is the start of a vertical chain, this attribute will drive how
          * the elements of the chain will be positioned. The possible values are:
          * <ul>
-         * <li>{@see CHAIN_SPREAD} -- the elements will be spread out</li>
-         * <li>{@see CHAIN_SPREAD_INSIDE} -- similar, but the endpoints of the chain will not be spread out</li>
-         * <li>{@see CHAIN_PACKED} -- the elements of the chain will be packed together. The vertical
-         * bias attribute of the child will then affect the positioning of the packed elements</li>
+         * <li>{@link #CHAIN_SPREAD} -- the elements will be spread out</li>
+         * <li>{@link #CHAIN_SPREAD_INSIDE} -- similar, but the endpoints of the chain will not
+         * be spread out</li>
+         * <li>{@link #CHAIN_PACKED} -- the elements of the chain will be packed together. The
+         * vertical bias attribute of the child will then affect the positioning of the packed
+         * elements</li>
          * </ul>
          */
         public int verticalChainStyle = CHAIN_SPREAD;
 
         /**
          * Define how the widget horizontal dimension is handled when set to MATCH_CONSTRAINT
          * <ul>
-         * <li>{@see MATCH_CONSTRAINT_SPREAD} -- the default. The dimension will expand up to the constraints, minus margins</li>
-         * <li>{@see MATCH_CONSTRAINT_WRAP} -- DEPRECATED -- use instead WRAP_CONTENT and constrainedWidth=true<br>
+         * <li>{@link #MATCH_CONSTRAINT_SPREAD} -- the default. The dimension will expand up to
+         * the constraints, minus margins</li>
+         * <li>{@link #MATCH_CONSTRAINT_WRAP} -- DEPRECATED -- use instead WRAP_CONTENT and
+         * constrainedWidth=true<br>
          * The dimension will be the same as WRAP_CONTENT, unless the size ends
          * up too large for the constraints; in that case the dimension will expand up to the constraints, minus margins</li>
          * This attribute may not be applied if the widget is part of a chain in that dimension.
-         * <li>{@see MATCH_CONSTRAINT_PERCENT} -- The dimension will be a percent of another widget (by default, the parent)</li>
+         * <li>{@link #MATCH_CONSTRAINT_PERCENT} -- The dimension will be a percent of another
+         * widget (by default, the parent)</li>
          * </ul>
          */
         public int matchConstraintDefaultWidth = MATCH_CONSTRAINT_SPREAD;
 
         /**
          * Define how the widget vertical dimension is handled when set to MATCH_CONSTRAINT
          * <ul>
-         * <li>{@see MATCH_CONSTRAINT_SPREAD} -- the default. The dimension will expand up to the constraints, minus margins</li>
-         * <li>{@see MATCH_CONSTRAINT_WRAP} -- DEPRECATED -- use instead WRAP_CONTENT and constrainedHeight=true<br>
+         * <li>{@link #MATCH_CONSTRAINT_SPREAD} -- the default. The dimension will expand up to
+         * the constraints, minus margins</li>
+         * <li>{@link #MATCH_CONSTRAINT_WRAP} -- DEPRECATED -- use instead WRAP_CONTENT and
+         * constrainedWidth=true<br>
          * The dimension will be the same as WRAP_CONTENT, unless the size ends
          * up too large for the constraints; in that case the dimension will expand up to the constraints, minus margins</li>
          * This attribute may not be applied if the widget is part of a chain in that dimension.
-         * <li>{@see MATCH_CONSTRAINT_PERCENT} -- The dimension will be a percent of another widget (by default, the parent)</li>
+         * <li>{@link #MATCH_CONSTRAINT_PERCENT} -- The dimension will be a percent of another
+         * widget (by default, the parent)</li>
          * </ul>
          */
         public int matchConstraintDefaultHeight = MATCH_CONSTRAINT_SPREAD;

constraintlayout/constraintlayout/src/main/java/androidx/constraintlayout/widget/ConstraintSet.java

@@ -72,8 +72,7 @@
  * </li>
  * </ul><p>
  * Example code:<br>
- * {@sample resources/examples/ExampleConstraintSet.java
- * Example}
+ * {@sample resources/examples/ExampleConstraintSet.java Example}
  */
 public class ConstraintSet {
     private static final String TAG = "ConstraintSet";
@@ -3617,10 +3616,14 @@ public void setVerticalWeight(int viewId, float weight) {
      * How the elements of the horizontal chain will be positioned. if the dimension
      * behaviour is set to MATCH_CONSTRAINT. The possible values are:
      *
-     * <ul> <li>{@see CHAIN_SPREAD} -- the elements will be spread out</li> <li>{@see
-     * CHAIN_SPREAD_INSIDE} -- similar, but the endpoints of the chain will not be spread out</li>
-     * <li>{@see CHAIN_PACKED} -- the elements of the chain will be packed together. The horizontal
-     * bias attribute of the child will then affect the positioning of the packed elements</li> </ul>
+     * <ul>
+     * <li>{@link #CHAIN_SPREAD} -- the elements will be spread out</li>
+     * <li>{@link #CHAIN_SPREAD_INSIDE} -- similar, but the endpoints of the chain will not
+     * be spread out</li>
+     * <li>{@link #CHAIN_PACKED} -- the elements of the chain will be packed together. The
+     * horizontal bias attribute of the child will then affect the positioning of the packed
+     * elements</li>
+     * </ul>
      *
      * @param viewId     ID of view to adjust its HorizontalChainStyle
      * @param chainStyle the weight that we can use to distribute the horizontal space
@@ -3633,10 +3636,14 @@ public void setHorizontalChainStyle(int viewId, int chainStyle) {
      * How the elements of the vertical chain will be positioned. in a chain, if the dimension
      * behaviour is set to MATCH_CONSTRAINT
      *
-     * <ul> <li>{@see CHAIN_SPREAD} -- the elements will be spread out</li> <li>{@see
-     * CHAIN_SPREAD_INSIDE} -- similar, but the endpoints of the chain will not be spread out</li>
-     * <li>{@see CHAIN_PACKED} -- the elements of the chain will be packed together. The horizontal
-     * bias attribute of the child will then affect the positioning of the packed elements</li> </ul>
+     * <ul>
+     * <li>{@link #CHAIN_SPREAD} -- the elements will be spread out</li>
+     * <li>{@link #CHAIN_SPREAD_INSIDE} -- similar, but the endpoints of the chain will not
+     * be spread out</li>
+     * <li>{@link #CHAIN_PACKED} -- the elements of the chain will be packed together. The
+     * vertical bias attribute of the child will then affect the positioning of the packed
+     * elements</li>
+     * </ul>
      *
      * @param viewId     ID of view to adjust its VerticalChainStyle
      * @param chainStyle the weight that we can use to distribute the horizontal space

constraintlayout/constraintlayout/src/main/java/androidx/constraintlayout/widget/Guideline.java

@@ -48,8 +48,7 @@
  * and {@link ConstraintSet#setGuidelinePercent} functions in {@link ConstraintSet}.
  * <p>
  * Example of a {@code Button} constrained to a vertical {@code Guideline}:<br>
- * {@sample resources/examples/Guideline.xml
- *          Guideline}
+ * {@sample resources/examples/Guideline.xml Guideline}
  */
 public class Guideline extends View {
     public Guideline(Context context) {