Enhancement for docprocessor

[johnmarquez12]

Current implementation of the DocProcessor provides access to types that extend the Element class such as TypeElement, ExecutableElement and VariableElement. However extracting javadoc from these is not possible without access to a DocTrees object, example shown in usages here. By providing access to the DocletEnvironment to the DocProcessor functions, we can get access to objects that can properly evaluate the javadoc of these elements.

[jansupol]

This one is difficult.

On one hand, it breaks backward compatibility. It changes the DocProcessor interface which can be implemented by users, and the user implementation will stop working. I'd like to avoid this.

On the other hand, making the change backward compatible is challenging. Jersey made backward-incompatible changes in the past, but it is not ideal.

Will need to give this more thoughts

[jansupol]

The issue can be with users implementing their own DocProcessor, which is being loaded by the ResourceDoclet. One option is to deprecate the methods in DocProcessor and create the default methods with the third arg there. The default methods just invoke the deprecated methods. The new implementation of course will override the default methods.

How ugly does that sound?

[johnmarquez12]

The issue can be with users implementing their own DocProcessor, which is being loaded by the ResourceDoclet. One option is to deprecate the methods in DocProcessor and create the default methods with the third arg there. The default methods just invoke the deprecated methods. The new implementation of course will override the default methods.

How ugly does that sound?

Would deprecating the old methods and adding new ones with a third arg in DocProcessor, then calling the new methods along with the deprecated ones in ResourceDoclet be enough? This would at least give users time to move to the new methods. Sort of in line with what you suggested.

[jbescos]

The issue can be with users implementing their own DocProcessor, which is being loaded by the ResourceDoclet. One option is to deprecate the methods in DocProcessor and create the default methods with the third arg there. The default methods just invoke the deprecated methods. The new implementation of course will override the default methods.

How ugly does that sound?

It looks ugly for a while, but eventually we can remove the deprecated methods and it will look pretty again.

I'm fine with this solution.

[jbescos]

LGTM