Uploaded image for project: 'OptaPlanner'
  1. OptaPlanner
  2. PLANNER-399

Warnings in javadoc's doclint check

XMLWordPrintable

    • NEW
    • NEW

      When building the javadocs with Oracle JDK 8, the following warning are reported:

      cd optaplanner-distribution
      mvn clean install
      ...
      26 warnings
      [WARNING] Javadoc Warnings
      [WARNING] /home/oskopek/git/droolsjbpm/optaplanner/optaplanner-core/src/main/java/org/optaplanner/core/config/heuristic/selector/entity/pillar/PillarSelectorConfig.java:91: warning: no @param for variableNameIncludeList
      [WARNING] public PillarSelector buildPillarSelector(HeuristicConfigPolicy configPolicy,
      [WARNING] ^
      [WARNING] /home/oskopek/git/droolsjbpm/optaplanner/optaplanner-core/src/main/java/org/optaplanner/core/config/heuristic/selector/move/MoveSelectorConfig.java:209: warning: no @param for configPolicy
      [WARNING] protected MoveSelectorConfig buildUnfoldedMoveSelectorConfig(HeuristicConfigPolicy configPolicy) {
      [WARNING] ^
      [WARNING] /home/oskopek/git/droolsjbpm/optaplanner/optaplanner-core/src/main/java/org/optaplanner/core/impl/score/director/easy/EasyScoreCalculator.java:27: warning: no description for @param
      [WARNING] * @param <Sol>
      [WARNING] ^
      [WARNING] /home/oskopek/git/droolsjbpm/optaplanner/optaplanner-core/src/main/java/org/optaplanner/core/impl/score/director/incremental/ConstraintMatchAwareIncrementalScoreCalculator.java:29: warning: no description for @param
      [WARNING] * @param <Sol>
      [WARNING] ^
      [WARNING] /home/oskopek/git/droolsjbpm/optaplanner/optaplanner-core/src/main/java/org/optaplanner/core/impl/score/director/incremental/IncrementalScoreCalculator.java:31: warning: no description for @param
      [WARNING] * @param <Sol>
      [WARNING] ^
      [WARNING] /home/oskopek/git/droolsjbpm/optaplanner/optaplanner-core/src/main/java/org/optaplanner/core/impl/heuristic/selector/entity/mimic/EntityMimicRecorder.java:34: warning: no @return
      [WARNING] EntityDescriptor getEntityDescriptor();
      [WARNING] ^
      [WARNING] /home/oskopek/git/droolsjbpm/optaplanner/optaplanner-core/src/main/java/org/optaplanner/core/impl/heuristic/selector/entity/mimic/EntityMimicRecorder.java:39: warning: no @return
      [WARNING] boolean isCountable();
      [WARNING] ^
      [WARNING] /home/oskopek/git/droolsjbpm/optaplanner/optaplanner-core/src/main/java/org/optaplanner/core/impl/heuristic/selector/entity/mimic/EntityMimicRecorder.java:44: warning: no @return
      [WARNING] boolean isNeverEnding();
      [WARNING] ^
      [WARNING] /home/oskopek/git/droolsjbpm/optaplanner/optaplanner-core/src/main/java/org/optaplanner/core/impl/heuristic/selector/entity/mimic/EntityMimicRecorder.java:49: warning: no @return
      [WARNING] long getSize();
      [WARNING] ^
      [WARNING] /home/oskopek/git/droolsjbpm/optaplanner/optaplanner-core/src/main/java/org/optaplanner/core/impl/heuristic/selector/entity/mimic/EntityMimicRecorder.java:54: warning: no @return
      [WARNING] Iterator<Object> endingIterator();
      [WARNING] ^
      [WARNING] /home/oskopek/git/droolsjbpm/optaplanner/optaplanner-core/src/main/java/org/optaplanner/core/impl/heuristic/selector/value/ValueSelector.java:62: warning: no @param for entity
      [WARNING] Iterator<Object> endingIterator(Object entity);
      [WARNING] ^
      [WARNING] /home/oskopek/git/droolsjbpm/optaplanner/optaplanner-core/src/main/java/org/optaplanner/core/impl/heuristic/selector/common/iterator/CachedListRandomIterator.java:25: warning: no description for @param
      [WARNING] * @param <S>
      [WARNING] ^
      [WARNING] /home/oskopek/git/droolsjbpm/optaplanner/optaplanner-core/src/main/java/org/optaplanner/core/impl/heuristic/selector/common/iterator/UpcomingSelectionIterator.java:30: warning: no description for @param
      [WARNING] * @param <S>
      [WARNING] ^
      [WARNING] /home/oskopek/git/droolsjbpm/optaplanner/optaplanner-core/src/main/java/org/optaplanner/core/impl/heuristic/move/CompositeMove.java:40: warning: no @return
      [WARNING] public static Move buildMove(Move... moves) {
      [WARNING] ^
      [WARNING] /home/oskopek/git/droolsjbpm/optaplanner/optaplanner-core/src/main/java/org/optaplanner/core/impl/heuristic/move/CompositeMove.java:54: warning: no @return
      [WARNING] public static Move buildMove(List<Move> moveList) {
      [WARNING] ^
      [WARNING] /home/oskopek/git/droolsjbpm/optaplanner/optaplanner-core/src/main/java/org/optaplanner/core/impl/domain/variable/supply/SupplyManager.java:28: warning: no description for @param
      [WARNING] * @param <S>
      [WARNING] ^
      [WARNING] /home/oskopek/git/droolsjbpm/optaplanner/optaplanner-core/src/main/java/org/optaplanner/core/impl/domain/variable/supply/Demand.java:26: warning: no description for @param
      [WARNING] * @param <S>
      [WARNING] ^
      [WARNING] /home/oskopek/git/droolsjbpm/optaplanner/optaplanner-core/src/main/java/org/optaplanner/core/impl/solver/XStreamXmlSolverFactory.java:65: warning: no @param for xStreamAnnotations
      [WARNING] public void addXStreamAnnotations(Class... xStreamAnnotations) {
      [WARNING] ^
      [WARNING] /home/oskopek/git/droolsjbpm/optaplanner/optaplanner-core/src/main/java/org/optaplanner/core/api/domain/valuerange/ValueRangeFactory.java:80: warning: no @return
      [WARNING] public static ValueRange<Double> createDoubleValueRange(double from, double to) {
      [WARNING] ^
      [WARNING] /home/oskopek/git/droolsjbpm/optaplanner/optaplanner-core/src/main/java/org/optaplanner/core/api/domain/valuerange/ValueRangeFactory.java:89: warning: no @return
      [WARNING] public static CountableValueRange<BigInteger> createBigIntegerValueRange(BigInteger from, BigInteger to) {
      [WARNING] ^
      [WARNING] /home/oskopek/git/droolsjbpm/optaplanner/optaplanner-core/src/main/java/org/optaplanner/core/api/domain/valuerange/ValueRangeFactory.java:99: warning: no @return
      [WARNING] public static CountableValueRange<BigInteger> createBigIntegerValueRange(BigInteger from, BigInteger to, BigInteger incrementUnit) {
      [WARNING] ^
      [WARNING] /home/oskopek/git/droolsjbpm/optaplanner/optaplanner-core/src/main/java/org/optaplanner/core/api/domain/valuerange/ValueRangeFactory.java:109: warning: no @return
      [WARNING] public static CountableValueRange<BigDecimal> createBigDecimalValueRange(BigDecimal from, BigDecimal to) {
      [WARNING] ^
      [WARNING] /home/oskopek/git/droolsjbpm/optaplanner/optaplanner-core/src/main/java/org/optaplanner/core/api/domain/valuerange/ValueRangeFactory.java:120: warning: no @return
      [WARNING] public static CountableValueRange<BigDecimal> createBigDecimalValueRange(BigDecimal from, BigDecimal to, BigDecimal incrementUnit) {
      [WARNING] ^
      [WARNING] /home/oskopek/git/droolsjbpm/optaplanner/optaplanner-core/src/main/java/org/optaplanner/core/api/solver/event/BestSolutionChangedEvent.java:77: warning: no @return
      [WARNING] public boolean isEveryProblemFactChangeProcessed() {
      [WARNING] ^
      [WARNING] /home/oskopek/git/droolsjbpm/optaplanner/optaplanner-benchmark/src/main/java/org/optaplanner/benchmark/impl/XStreamXmlPlannerBenchmarkFactory.java:55: warning: no @param for xStreamAnnotations
      [WARNING] public void addXStreamAnnotations(Class... xStreamAnnotations) {
      [WARNING] ^
      [WARNING] /home/oskopek/git/droolsjbpm/optaplanner/optaplanner-benchmark/src/main/java/org/optaplanner/benchmark/impl/result/SolverBenchmarkResult.java:251: warning: no @param for benchmarkReport
      [WARNING] public void accumulateResults(BenchmarkReport benchmarkReport) {
      [WARNING] ^
      
      

      These warnings only show with the Oracle JDK 8, not with OpenJDK 8, or with any JDK 6 or 7.

              gdesmet@redhat.com Geoffrey De Smet (Inactive)
              oskopek Ondrej Skopek (Inactive)
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Created:
                Updated:
                Resolved: