Uploaded image for project: 'Maven Javadoc Plugin'
  1. Maven Javadoc Plugin
  2. MJAVADOC-606

doclint fails checking references on dependencies with scope 'provided'

    XMLWordPrintableJSON

Details

    • Improvement
    • Status: Closed
    • Major
    • Resolution: Not A Problem
    • 3.1.0
    • None
    • javadoc
    • None

    Description

      Referencing classes from a dependency with scope provided in javadoc using @link fails due to doclint error. It happens during phase javadoc:aggregate. As written in the documentation, the scope compile is used when generating javadoc: "Requires dependency resolution of artifacts in scope: compile". However, there should be a way to reference external classes with scope provided because:

      • sometimes we need to explain something that will happen if the dependency is present or not
      • sometimes we need to explain features that are handled by external dependency provided by external system (like Spring Boot or JavaEE server)

      For the moment, the only possibility is to disable "reference" group for doclint which is bad because I can't ensure that all internal references are working.

      <dependency>
      	<groupId>org.springframework.boot</groupId>
      	<artifactId>spring-boot-autoconfigure</artifactId>
      	<scope>provided</scope>
      </dependency>
      
      /**
       * see {@link WebMvcAutoConfiguration} to ...
       */
      class Foo {
      }
      

      Attachments

        Activity

          People

            rfscholte Robert Scholte
            aurelien-baudet Aurélien Baudet
            Votes:
            1 Vote for this issue
            Watchers:
            3 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: