in tobago-tool/tobago-tool-apt/src/main/java/org/apache/myfaces/tobago/apt/processor/TaglibGenerator.java [246:314]
protected void addDescription(
final javax.lang.model.element.Element typeElement, final Element element, final Document document,
final boolean deprecated) {
final StringBuilder description = new StringBuilder();
final Deprecated deprecatedAnnotation = typeElement.getAnnotation(Deprecated.class);
String comment = processingEnv.getElementUtils().getDocComment(typeElement);
final String deprecationComment = deprecationComment(comment);
if (deprecatedAnnotation != null || deprecationComment != null) {
description.append("<p>**** @deprecated. Will be removed in a future version **** </p>");
}
if (deprecated) {
final Tag annotationTag = typeElement.getAnnotation(Tag.class);
description.append("<p>**** @deprecated. Will be removed in a future version. Use ");
description.append(annotationTag.name());
description.append(" instead. **** </p>");
}
if (deprecationComment != null) {
description.append("<p>").append(deprecationComment).append("</p>");
}
final Preliminary preliminary = typeElement.getAnnotation(Preliminary.class);
if (preliminary != null) {
description.append("<p>**** Preliminary. Maybe subject to changed in a future version");
if (preliminary.value().length() > 0) {
description.append(": ");
description.append(preliminary.value());
}
description.append(" **** </p>");
}
if (comment != null) {
// remove @param section
final int index = comment.indexOf(" @");
if (index != -1) {
comment = comment.substring(0, index);
}
comment = comment.trim();
if (comment.length() > 0) {
//description.append("<p>");
description.append(comment);
//description.append("</p>");
}
}
final UIComponentTag componentTag = typeElement.getAnnotation(UIComponentTag.class);
if (componentTag != null) {
description.append(createDescription(componentTag));
}
final UIComponentTagAttribute attributeTag = typeElement.getAnnotation(UIComponentTagAttribute.class);
if (attributeTag != null) {
if (attributeTag.type().length > 0) {
description.append("<br />Type: <code>")
.append(attributeTag.type().length == 1 ? attributeTag.type()[0] : Arrays.toString(attributeTag.type()))
.append("</code>");
}
if (StringUtils.isNotEmpty(attributeTag.defaultValue())) {
description.append("<br />Default: <code>")
.append(attributeTag.defaultValue())
.append("</code>");
}
if (attributeTag.allowedValues().length > 0) {
description.append("<br />Allowed Values: <code>")
.append(Arrays.toString(attributeTag.allowedValues()))
.append("</code>");
}
}
if (description.length() > 0) {
addLeafCDATAElement(description.toString(), "description", element, document);
}
}