[jira] [Closed] (MJAVADOC-606) doclint fails checking references on dependencies with scope 'provided'

["Robert Scholte (Jira)" <ji...@apache.org>]

     [ https://issues.apache.org/jira/browse/MJAVADOC-606?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Robert Scholte closed MJAVADOC-606.
-----------------------------------
      Assignee: Robert Scholte
    Resolution: Not A Problem

So let's close this one as 'not a problem'

> doclint fails checking references on dependencies with scope 'provided'
> -----------------------------------------------------------------------
>
>                 Key: MJAVADOC-606
>                 URL: https://issues.apache.org/jira/browse/MJAVADOC-606
>             Project: Maven Javadoc Plugin
>          Issue Type: Improvement
>          Components: javadoc
>    Affects Versions: 3.1.0
>            Reporter: Aurélien Baudet
>            Assignee: Robert Scholte
>            Priority: Major
>
> 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.
> {code:xml}
> <dependency>
> 	<groupId>org.springframework.boot</groupId>
> 	<artifactId>spring-boot-autoconfigure</artifactId>
> 	<scope>provided</scope>
> </dependency>
> {code}
> {code:java}
> /**
>  * see {@link WebMvcAutoConfiguration} to ...
>  */
> class Foo {
> }
> {code}



--
This message was sent by Atlassian Jira
(v8.3.4#803005)