api / org.gradle.external.javadoc / StandardJavadocDocletOptions / isLinkSource

isLinkSource

@Input open fun isLinkSource(): Boolean

-linksource

Creates an HTML version of each source file (with line numbers) and adds links to them from the standard HTML documentation. Links are created for classes, interfaces, constructors, methods and fields whose declarations are in a source file. Otherwise, links are not created, such as for default constructors and generated classes. This option exposes all private implementation details in the included source files, including private classes, private fields, and the bodies of private methods, regardless of the -public, -package, -protected and -private options. Unless you also use the -private option, not all private classes or interfaces will necessarily be accessible via links.

Each link appears on the name of the identifier in its declaration. For example, the link to the source code of the Button class would be on the word "Button":

public class Button extends Component implements Accessible and the link to the source code of the getLabel() method in the Button class would be on the word "getLabel": public String getLabel()