Summary

Add a toString((List<? extends DocTree> , Element, String) default method to interface jdk.javadoc.doclet.Taglet that accepts the relative path to the documentation root as third argument.

Problem

Taglets can usually defer the relative path of the containing page from the Element argument passed to the toString method. However, sometimes taglets are rendered outside the context of the defining element, for example when the first sentence of an element's description is used in a summary page. There is currently no way a taglet can determine the relative path of the page in which a taglet is being rendered.

Solution

Add a new toString((List<? extends DocTree> tags, Element element, String pathToRoot) default method to interface jdk.javadoc.doclet.Taglet. The third parameter is the relative path from the page currently being rendered to the API documentation root directory.

Specification

TBD