Javadoc symbol doesn't show in Find usage

Answered

Hi,

I have the following use case :

- a Java server with Rest controllers that expose endpoints

- a Java client

- some Java applications that use the Java client

All are in different maven modules but in the same project. So the client doesn't have a dependency on the server.

 

We'd like to be able to reference the controller method in the client javadoc with @see so that Intellij correctly recognizes them as usages of the controllers and allow to use Call Hierarchy to see where the controllers are used in the final applications.

Like this :

/**
* @see com.myapp.controllers.MyObjectController#get(java.lang.Integerr)
*/
MyObject get(Integer objectId){

// call the server

}

The issue is that Intellij doesn't recognize the Symbol MyObjectController unless we add a maven dependency to it which we do not want to add just for documentation reasons...

I tried to use maven Javadoc additionnalRepositories (https://maven.apache.org/plugins/maven-javadoc-plugin/examples/additional-dependencies.html) but it seems deprecated.

I understand that Intellij should have the option to report inaccessible symbols for Javadoc, but maybe Intellij should still report them in Find usage and Hierarchy ?

Is there an alternative I missed ?

 

Thanks for the help,

Benoit

0
2 comments

Since the dependency is not defined between these modules, it's not really a usage.

Maybe you can configure a dependency with the provided scope?

0
Avatar
Permanently deleted user

I see...

Indeed putting the dependency as provided works.

Thanks for the feedback!

0

Please sign in to leave a comment.