getJavaDoc() — spring-boot Function Reference

Architecture documentation for the getJavaDoc() function in TypeUtils.java from the spring-boot codebase.

Function java GradlePlugin AotProcessing calls 2

Entity Profile

GradlePlugin→ AotProcessing→ getJavaDoc() — spring-boot Function Reference

Dependency Diagram

graph TD
  6b5a91f7_a152_1f89_8c9d_bb1dcbfc7a05["getJavaDoc()"]
  91c341b7_922f_7206_04ad_ddbb06cc1920["cleanUpJavaDoc()"]
  6b5a91f7_a152_1f89_8c9d_bb1dcbfc7a05 -->|calls| 91c341b7_922f_7206_04ad_ddbb06cc1920
  824296bb_83eb_ef20_7ae5_494326bd73db["paramJavadocPattern()"]
  6b5a91f7_a152_1f89_8c9d_bb1dcbfc7a05 -->|calls| 824296bb_83eb_ef20_7ae5_494326bd73db
  style 6b5a91f7_a152_1f89_8c9d_bb1dcbfc7a05 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

configuration-metadata/spring-boot-configuration-processor/src/main/java/org/springframework/boot/configurationprocessor/TypeUtils.java lines 179–186

	String getJavaDoc(Element element) {
		if (element instanceof RecordComponentElement) {
			return getJavaDoc((RecordComponentElement) element);
		}
		String javadoc = (element != null) ? this.env.getElementUtils().getDocComment(element) : null;
		javadoc = (javadoc != null) ? cleanUpJavaDoc(javadoc) : null;
		return (javadoc == null || javadoc.isEmpty()) ? null : javadoc;
	}