Skip to content

Commit 0dda883

Browse files
committed
Remove non-decribed auto generated parameter from javadoc
1 parent bdfbec1 commit 0dda883

File tree

14 files changed

+3
-236
lines changed

14 files changed

+3
-236
lines changed

MPChartLib/src/main/java/com/github/mikephil/charting/charts/BarChart.java

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -94,9 +94,6 @@ protected void calcMinMax() {
9494
* Returns the Highlight object (contains x-index and DataSet index) of the selected value at the given touch
9595
* point
9696
* inside the BarChart.
97-
*
98-
* @param x
99-
* @param y
10097
*/
10198
@Override
10299
public Highlight getHighlightByTouchPoint(float x, float y) {
@@ -118,8 +115,6 @@ public Highlight getHighlightByTouchPoint(float x, float y) {
118115
/**
119116
* Returns the bounding box of the specified Entry in the specified DataSet. Returns null if the Entry could not be
120117
* found in the charts data. Performance-intensive code should use void getBarBounds(BarEntry, RectF) instead.
121-
*
122-
* @param barEntry
123118
*/
124119
public RectF getBarBounds(BarEntry barEntry) {
125120

@@ -132,8 +127,6 @@ public RectF getBarBounds(BarEntry barEntry) {
132127
/**
133128
* The passed outputRect will be assigned the values of the bounding box of the specified Entry in the specified DataSet.
134129
* The rect will be assigned Float.MIN_VALUE in all locations if the Entry could not be found in the charts data.
135-
*
136-
* @param barEntry
137130
*/
138131
public void getBarBounds(BarEntry barEntry, RectF outputRect) {
139132

@@ -214,9 +207,6 @@ public boolean isHighlightFullBarEnabled() {
214207
/**
215208
* Highlights the value at the given x-value in the given DataSet. Provide
216209
* -1 as the dataSetIndex to undo all highlighting.
217-
*
218-
* @param x
219-
* @param dataSetIndex
220210
* @param stackIndex the index inside the stack - only relevant for stacked entries
221211
*/
222212
public void highlightValue(float x, int dataSetIndex, int stackIndex) {

MPChartLib/src/main/java/com/github/mikephil/charting/charts/Chart.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1557,7 +1557,7 @@ protected void onDetachedFromWindow() {
15571557

15581558
/**
15591559
* Unbind all drawables to avoid memory leaks.
1560-
* Link: http://stackoverflow.com/a/6779164/1590502
1560+
* Link: <a href="http://stackoverflow.com/a/6779164/1590502">...</a>
15611561
*/
15621562
private void unbindDrawables(View view) {
15631563

@@ -1576,7 +1576,7 @@ private void unbindDrawables(View view) {
15761576
* Set this to true to enable "unbinding" of drawables. When a View is detached
15771577
* from a window. This helps avoid memory leaks.
15781578
* Default: false
1579-
* Link: http://stackoverflow.com/a/6779164/1590502
1579+
* Link: <a href="http://stackoverflow.com/a/6779164/1590502">...</a>
15801580
*/
15811581
public void setUnbindEnabled(boolean enabled) {
15821582
this.mUnbind = enabled;

MPChartLib/src/main/java/com/github/mikephil/charting/charts/HorizontalBarChart.java

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -247,10 +247,6 @@ public void getBarBounds(BarEntry barEntry, RectF outputRect) {
247247

248248
/**
249249
* Returns a recyclable MPPointF instance.
250-
*
251-
* @param e
252-
* @param axis
253-
* @return
254250
*/
255251
@Override
256252
public MPPointF getPosition(Entry e, AxisDependency axis) {
@@ -270,10 +266,6 @@ public MPPointF getPosition(Entry e, AxisDependency axis) {
270266
/**
271267
* Returns the Highlight object (contains x-index and DataSet index) of the selected value at the given touch point
272268
* inside the BarChart.
273-
*
274-
* @param x
275-
* @param y
276-
* @return
277269
*/
278270
@Override
279271
public Highlight getHighlightByTouchPoint(float x, float y) {

MPChartLib/src/main/java/com/github/mikephil/charting/components/Legend.java

Lines changed: 0 additions & 66 deletions
Original file line numberDiff line numberDiff line change
@@ -154,8 +154,6 @@ public Legend() {
154154

155155
/**
156156
* Constructor. Provide entries for the legend.
157-
*
158-
* @param entries
159157
*/
160158
public Legend(LegendEntry[] entries) {
161159
this();
@@ -169,8 +167,6 @@ public Legend(LegendEntry[] entries) {
169167

170168
/**
171169
* This method sets the automatically computed colors for the legend. Use setCustom(...) to set custom colors.
172-
*
173-
* @param entries
174170
*/
175171
public void setEntries(List<LegendEntry> entries) {
176172
mEntries = entries.toArray(new LegendEntry[entries.size()]);
@@ -185,7 +181,6 @@ public LegendEntry[] getEntries() {
185181
* + formtotextspace
186182
*
187183
* @param p the paint object used for rendering the text
188-
* @return
189184
*/
190185
public float getMaximumEntryWidth(Paint p) {
191186

@@ -216,7 +211,6 @@ public float getMaximumEntryWidth(Paint p) {
216211
* returns the maximum height in pixels across all legend labels
217212
*
218213
* @param p the paint object used for rendering the text
219-
* @return
220214
*/
221215
public float getMaximumEntryHeight(Paint p) {
222216

@@ -324,152 +318,118 @@ public boolean isLegendCustom() {
324318

325319
/**
326320
* returns the horizontal alignment of the legend
327-
*
328-
* @return
329321
*/
330322
public LegendHorizontalAlignment getHorizontalAlignment() {
331323
return mHorizontalAlignment;
332324
}
333325

334326
/**
335327
* sets the horizontal alignment of the legend
336-
*
337-
* @param value
338328
*/
339329
public void setHorizontalAlignment(LegendHorizontalAlignment value) {
340330
mHorizontalAlignment = value;
341331
}
342332

343333
/**
344334
* returns the vertical alignment of the legend
345-
*
346-
* @return
347335
*/
348336
public LegendVerticalAlignment getVerticalAlignment() {
349337
return mVerticalAlignment;
350338
}
351339

352340
/**
353341
* sets the vertical alignment of the legend
354-
*
355-
* @param value
356342
*/
357343
public void setVerticalAlignment(LegendVerticalAlignment value) {
358344
mVerticalAlignment = value;
359345
}
360346

361347
/**
362348
* returns the orientation of the legend
363-
*
364-
* @return
365349
*/
366350
public LegendOrientation getOrientation() {
367351
return mOrientation;
368352
}
369353

370354
/**
371355
* sets the orientation of the legend
372-
*
373-
* @param value
374356
*/
375357
public void setOrientation(LegendOrientation value) {
376358
mOrientation = value;
377359
}
378360

379361
/**
380362
* returns whether the legend will draw inside the chart or outside
381-
*
382-
* @return
383363
*/
384364
public boolean isDrawInsideEnabled() {
385365
return mDrawInside;
386366
}
387367

388368
/**
389369
* sets whether the legend will draw inside the chart or outside
390-
*
391-
* @param value
392370
*/
393371
public void setDrawInside(boolean value) {
394372
mDrawInside = value;
395373
}
396374

397375
/**
398376
* returns the text direction of the legend
399-
*
400-
* @return
401377
*/
402378
public LegendDirection getDirection() {
403379
return mDirection;
404380
}
405381

406382
/**
407383
* sets the text direction of the legend
408-
*
409-
* @param pos
410384
*/
411385
public void setDirection(LegendDirection pos) {
412386
mDirection = pos;
413387
}
414388

415389
/**
416390
* returns the current form/shape that is set for the legend
417-
*
418-
* @return
419391
*/
420392
public LegendForm getForm() {
421393
return mShape;
422394
}
423395

424396
/**
425397
* sets the form/shape of the legend forms
426-
*
427-
* @param shape
428398
*/
429399
public void setForm(LegendForm shape) {
430400
mShape = shape;
431401
}
432402

433403
/**
434404
* sets the size in dp of the legend forms, default 8f
435-
*
436-
* @param size
437405
*/
438406
public void setFormSize(float size) {
439407
mFormSize = size;
440408
}
441409

442410
/**
443411
* returns the size in dp of the legend forms
444-
*
445-
* @return
446412
*/
447413
public float getFormSize() {
448414
return mFormSize;
449415
}
450416

451417
/**
452418
* sets the line width in dp for forms that consist of lines, default 3f
453-
*
454-
* @param size
455419
*/
456420
public void setFormLineWidth(float size) {
457421
mFormLineWidth = size;
458422
}
459423

460424
/**
461425
* returns the line width in dp for drawing forms that consist of lines
462-
*
463-
* @return
464426
*/
465427
public float getFormLineWidth() {
466428
return mFormLineWidth;
467429
}
468430

469431
/**
470432
* Sets the line dash path effect used for shapes that consist of lines.
471-
*
472-
* @param dashPathEffect
473433
*/
474434
public void setFormLineDashEffect(DashPathEffect dashPathEffect) {
475435
mFormLineDashEffect = dashPathEffect;
@@ -485,8 +445,6 @@ public DashPathEffect getFormLineDashEffect() {
485445
/**
486446
* returns the space between the legend entries on a horizontal axis in
487447
* pixels
488-
*
489-
* @return
490448
*/
491449
public float getXEntrySpace() {
492450
return mXEntrySpace;
@@ -495,17 +453,13 @@ public float getXEntrySpace() {
495453
/**
496454
* sets the space between the legend entries on a horizontal axis in pixels,
497455
* converts to dp internally
498-
*
499-
* @param space
500456
*/
501457
public void setXEntrySpace(float space) {
502458
mXEntrySpace = space;
503459
}
504460

505461
/**
506462
* returns the space between the legend entries on a vertical axis in pixels
507-
*
508-
* @return
509463
*/
510464
public float getYEntrySpace() {
511465
return mYEntrySpace;
@@ -514,17 +468,13 @@ public float getYEntrySpace() {
514468
/**
515469
* sets the space between the legend entries on a vertical axis in pixels,
516470
* converts to dp internally
517-
*
518-
* @param space
519471
*/
520472
public void setYEntrySpace(float space) {
521473
mYEntrySpace = space;
522474
}
523475

524476
/**
525477
* returns the space between the form and the actual label/text
526-
*
527-
* @return
528478
*/
529479
public float getFormToTextSpace() {
530480
return mFormToTextSpace;
@@ -533,26 +483,20 @@ public float getFormToTextSpace() {
533483
/**
534484
* sets the space between the form and the actual label/text, converts to dp
535485
* internally
536-
*
537-
* @param space
538486
*/
539487
public void setFormToTextSpace(float space) {
540488
this.mFormToTextSpace = space;
541489
}
542490

543491
/**
544492
* returns the space that is left out between stacked forms (with no label)
545-
*
546-
* @return
547493
*/
548494
public float getStackSpace() {
549495
return mStackSpace;
550496
}
551497

552498
/**
553499
* sets the space that is left out between stacked forms (with no label)
554-
*
555-
* @param space
556500
*/
557501
public void setStackSpace(float space) {
558502
mStackSpace = space;
@@ -583,8 +527,6 @@ public void setStackSpace(float space) {
583527
* wrapping a legend takes a toll on performance. / you may want to set
584528
* maxSizePercent when word wrapping, to set the point where the text wraps.
585529
* / default: false
586-
*
587-
* @param enabled
588530
*/
589531
public void setWordWrapEnabled(boolean enabled) {
590532
mWordWrapEnabled = enabled;
@@ -593,8 +535,6 @@ public void setWordWrapEnabled(boolean enabled) {
593535
/**
594536
* If this is set, then word wrapping the legend is enabled. This means the
595537
* legend will not be cut off if too long.
596-
*
597-
* @return
598538
*/
599539
public boolean isWordWrapEnabled() {
600540
return mWordWrapEnabled;
@@ -607,8 +547,6 @@ public boolean isWordWrapEnabled() {
607547
* affects the height of the legend. / If the legend is the center of the
608548
* piechart, then this defines the size of the rectangular bounds out of the
609549
* size of the "hole". / default: 0.95f (95%)
610-
*
611-
* @return
612550
*/
613551
public float getMaxSizePercent() {
614552
return mMaxSizePercent;
@@ -619,8 +557,6 @@ public float getMaxSizePercent() {
619557
* the legend is to the right/left of the chart, then this affects the width
620558
* of the legend. / If the legend is to the top/bottom of the chart, then
621559
* this affects the height of the legend. / default: 0.95f (95%)
622-
*
623-
* @param maxSize
624560
*/
625561
public void setMaxSizePercent(float maxSize) {
626562
mMaxSizePercent = maxSize;
@@ -646,8 +582,6 @@ public List<FSize> getCalculatedLineSizes() {
646582
* Calculates the dimensions of the Legend. This includes the maximum width
647583
* and height of a single entry, as well as the total width and height of
648584
* the Legend.
649-
*
650-
* @param labelpaint
651585
*/
652586
public void calculateDimensions(Paint labelpaint, ViewPortHandler viewPortHandler) {
653587

0 commit comments

Comments
 (0)