Skip to content

Commit

Permalink
Fixed malformed HTML javadoc output which breaks maven publish
Browse files Browse the repository at this point in the history
  • Loading branch information
lecho committed Feb 9, 2015
1 parent b510e81 commit 0c7ba1f
Show file tree
Hide file tree
Showing 10 changed files with 28 additions and 29 deletions.
6 changes: 3 additions & 3 deletions hellocharts-library/build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -82,9 +82,9 @@ publishing {
version android.defaultConfig.versionName

// Task androidSourcesJar is provided by gradle-mvn-push.gradle
artifact androidSourcesJar {
classifier "sources"
}
//artifact androidSourcesJar {
// classifier "sources"
//}
}
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ public interface AxisValueFormatter {

/**
* Used only for auto-generated axes. If you are not going to use your implementation for aut-generated axes you can
* skip implementation of this method and just return 0. </br> Formats values with given number of digits after
* skip implementation of this method and just return 0. SFormats values with given number of digits after
* decimal separator. Result is stored in given array. Method returns number of chars for formatted value. The
* formatted value starts at index [formattedValue.length - charsNumber] and ends at index [formattedValue.length-1].
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,6 @@ public ValueFormatterHelper setDecimalSeparator(char decimalSeparator) {
* Formats float value. Result is stored in (output) formattedValue array. Method
* returns number of chars of formatted value. The formatted value starts at index [formattedValue.length -
* charsNumber] and ends at index [formattedValue.length-1].
* <p/>
* Note: If label is not null it will be used as formattedValue instead of float value.
* Note: Parameter defaultDigitsNumber is used only if you didn't change decimalDigintsNumber value using
* method {@link #setDecimalDigitsNumber(int)}.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -209,7 +209,7 @@ public Axis setTextColor(int color) {
}

/**
* @see {{@link #setInside(boolean)}
* @see #setInside(boolean)
*/
public boolean isInside() {
return isInside;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -129,8 +129,8 @@ public float getBubbleScale() {
}

/**
* Set bubble scale which is used to adjust bubble size. If you want smaller bubbles set scale <0, 1>, if you want
* bigger bubbles set scale >1, default 1.0f.
* Set bubble scale which is used to adjust bubble size. If you want smaller bubbles set scale {@code <0, 1>},
* if you want bigger bubbles set scale greater than 1, default is 1.0f.
*/
public void setBubbleScale(float bubbleScale) {
this.bubbleScale = bubbleScale;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ public interface ChartData {
public void setAxisYRight(Axis axisY);

/**
* @see #see #setAxisYRight(Axis)
* @see #setAxisYRight(Axis)
*/
public Axis getAxisYRight();

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@
/**
* Single column for ColumnChart. One column can be divided into multiple sub-columns(ColumnValues) especially for
* stacked ColumnChart.
* <p/>
* Note: you can set X value for columns or sub-columns, columns are by default indexed from 0 to numOfColumns-1 and
* column index is used as column X value, so first column has X value 0, second clumn has X value 1 etc.
* If you want to display AxisValue for given column you should initialize AxisValue with X value of that column.
Expand Down
32 changes: 17 additions & 15 deletions hellocharts-library/src/lecho/lib/hellocharts/model/Viewport.java
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@
* Partial copy of android.graphics.Rect but here the top should be greater then the bottom. Viewport holds 4 float
* coordinates for a chart extremes. The viewport is represented by the coordinates of its 4 edges (left, top, right
* bottom). These fields can be accessed directly. Use width() and height() to retrieve the viewport's width and height.
* Note: most methods do not check to see that the coordinates are sorted correctly (i.e. left <= right and bottom <=
* top).
* Note: most methods do not check to see that the coordinates are sorted correctly (i.e. left is less than right and
* bottom is less than top).
*
* Viewport implements Parcerable.
*
Expand Down Expand Up @@ -48,7 +48,7 @@ public Viewport() {

/**
* Create a new viewport with the specified coordinates. Note: no range checking is performed, so the caller must
* ensure that left <= right and bottom <= top.
* ensure that left is less than right and bottom is less than top.
*
* @param left
* The X coordinate of the left side of the viewport
Expand Down Expand Up @@ -84,7 +84,7 @@ public Viewport(Viewport v) {
}

/**
* Returns true if the viewport is empty (left >= right or bottom >= top)
* Returns true if the viewport is empty {@code left >= right or bottom >= top}
*/
public final boolean isEmpty() {
return left >= right || bottom >= top;
Expand All @@ -98,38 +98,40 @@ public void setEmpty() {
}

/**
* @return the viewport's width. This does not check for a valid viewport (i.e. left <= right) so the result may be
* negative.
* @return the viewport's width. This does not check for a valid viewport (i.e. {@code left <= right}) so the
* result may be negative.
*/
public final float width() {
return right - left;
}

/**
* @return the viewport's height. This does not check for a valid viewport (i.e. top <= bottom) so the result may be
* negative.
* @return the viewport's height. This does not check for a valid viewport (i.e. {@code top <= bottom}) so the
* result may be negative.
*/
public final float height() {
return top - bottom;
}

/**
* @return the horizontal center of the viewport. This does not check for a valid viewport (i.e. left <= right)
* @return the horizontal center of the viewport. This does not check for a valid viewport (i.e. {@code left <=
* right})
*/
public final float centerX() {
return (left + right) * 0.5f;
}

/**
* @return the vertical center of the viewport. This does not check for a valid viewport (i.e. bottom <= top)
* @return the vertical center of the viewport. This does not check for a valid viewport (i.e. {@code bottom <=
* top})
*/
public final float centerY() {
return (top + bottom) * 0.5f;
}

/**
* Set the viewport's coordinates to the specified values. Note: no range checking is performed, so it is up to the
* caller to ensure that left <= right and bottom <= top.
* caller to ensure that {@code left <= right and bottom <= top}.
*
* @param left
* The X coordinate of the left side of the viewport
Expand Down Expand Up @@ -210,15 +212,15 @@ public void inset(float dx, float dy) {

/**
* Returns true if (x,y) is inside the viewport. The left and top are considered to be inside, while the right and
* bottom are not. This means that for a x,y to be contained: left <= x < right and bottom <= y < top. An empty
* viewport never contains any point.
* bottom are not. This means that for a x,y to be contained: {@code left <= x < right and bottom <= y < top}. An
* empty viewport never contains any point.
*
* @param x
* The X coordinate of the point being tested for containment
* @param y
* The Y coordinate of the point being tested for containment
* @return true iff (x,y) are contained by the viewport, where containment means left <= x < right and top <= y <
* bottom
* @return true iff (x,y) are contained by the viewport, where containment means {@code left <= x < right and top <=
* y < bottom}
*/
public boolean contains(float x, float y) {
return left < right && bottom < top // check for empty first
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,6 @@ public static float roundToOneSignificantFigure(double num) {
/**
* Formats a float value to the given number of decimals. Returns the length of the string. The string begins at
* [endIndex] - [return value] and ends at [endIndex]. It's up to you to check indexes correctness.
* <p/>
* Parameter [endIndex] can be helpful when you want to append some text to formatted value.
*
* @return number of characters of formatted value
Expand Down
6 changes: 3 additions & 3 deletions hellocharts-library/src/lecho/lib/hellocharts/view/Chart.java
Original file line number Diff line number Diff line change
Expand Up @@ -136,15 +136,15 @@ public interface Chart {
* Move/Srcoll viewport to position x,y(that position must be within maximum chart viewport). If possible viewport
* will be centered at this point. Width and height of viewport will not be modified.
*
* @see #setCurrentViewport(Viewport);
* @see #setCurrentViewport(lecho.lib.hellocharts.model.Viewport)
*/
public void moveTo(float x, float y);

/**
* Animate viewport to position x,y(that position must be within maximum chart viewport). If possible viewport
* will be centered at this point. Width and height of viewport will not be modified.
*
* @see #setCurrentViewport(Viewport);
* @see #setCurrentViewport(lecho.lib.hellocharts.model.Viewport) ;
*/
public void moveToWithAnimation(float x, float y);

Expand All @@ -168,7 +168,7 @@ public interface Chart {
public float getMaxZoom();

/**
* Set max zoom value >= 1. Default maximum zoom is 20.
* Set max zoom value. Default maximum zoom is 20.
*
*/
public void setMaxZoom(float maxZoom);
Expand Down

0 comments on commit 0c7ba1f

Please sign in to comment.