Skip to content

Commit badb736

Browse files
committed
Add documentation to axis
1 parent 1cecb82 commit badb736

File tree

1 file changed

+14
-4
lines changed
  • MPChartLib/src/com/github/mikephil/charting/components

1 file changed

+14
-4
lines changed

MPChartLib/src/com/github/mikephil/charting/components/AxisBase.java

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
import java.util.List;
1212

1313
/**
14-
* Baseclass of all labels.
14+
* Base-class of all axes (previously called labels).
1515
*
1616
* @author Philipp Jahoda
1717
*/
@@ -65,7 +65,14 @@ public abstract class AxisBase extends ComponentBase {
6565
*/
6666
protected boolean mCustomAxisMax = false;
6767

68+
/**
69+
* don't touch this direclty, use setter
70+
*/
6871
public float mAxisMaximum = 0f;
72+
73+
/**
74+
* don't touch this directly, use setter
75+
*/
6976
public float mAxisMinimum = 0f;
7077

7178
/**
@@ -365,8 +372,10 @@ public boolean isAxisMinCustom() {
365372
}
366373

367374
/**
368-
* Set a custom minimum value for this axis. If set, this value will not be calculated automatically depending on
369-
* the provided data. Use resetAxisMinValue() to undo this. Do not forget to call setStartAtZero(false) if you use
375+
* Set a custom minimum value for this axis. If set, this value will not be calculated
376+
* automatically depending on
377+
* the provided data. Use resetAxisMinValue() to undo this. Do not forget to call
378+
* setStartAtZero(false) if you use
370379
* this method. Otherwise, the axis-minimum value will still be forced to 0.
371380
*
372381
* @param min
@@ -377,7 +386,8 @@ public void setAxisMinValue(float min) {
377386
}
378387

379388
/**
380-
* Set a custom maximum value for this axis. If set, this value will not be calculated automatically depending on
389+
* Set a custom maximum value for this axis. If set, this value will not be calculated
390+
* automatically depending on
381391
* the provided data. Use resetAxisMaxValue() to undo this.
382392
*
383393
* @param max

0 commit comments

Comments
 (0)