Uploaded image for project: 'Commons Math'
  1. Commons Math
  2. MATH-1665

Shouldn't the build fail on missing Javadoc?

    XMLWordPrintableJSON

Details

    • Task
    • Status: Open
    • Minor
    • Resolution: Unresolved
    • None
    • None
    • legacy, legacy-core
    • None
    • Easy

    Description

      Running maven (default goal) results in a successful build, even though some Javadoc is (partly) missing; e.g.

          /**
           * @param lineSearcher
           */
          protected void setLineSearcher(LineSearch lineSearcher) {
              this.lineSearcher = lineSearcher;
          }
      

      results in

      [WARNING] * @param lineSearcher
      [WARNING] ^
      [WARNING] /home/gilles/gilles/devel/java/apache/commons-math/trunk/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/optim/nonlinear/scalar/gradient/GradientLikeOptimizer.java:209: warning: no description for @param
      

      whereas, according to our "full documentation" requirement, the build should fail.

      Attachments

        Issue Links

          Activity

            People

              Unassigned Unassigned
              erans Gilles Sadowski
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

                Created:
                Updated: