functions.Javadoc.ext Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jeaf-generator Show documentation
There is a newer version: 1.24.1
extension functions::JEAFDeprecated;
extension functions::Alias;
extension functions::SoftLink;
extension functions::BreakingChange;
extension functions::Example;
extension functions::DefaultComment;
extension java::GeneratorCommons;

cached String getAuthor():
    JAVA com.anaptecs.jeaf.fwk.generator.util.GeneratorCommons.getAuthor();
    
cached String getVersion():
    JAVA com.anaptecs.jeaf.fwk.generator.util.GeneratorCommons.getVersion();

cached boolean hasMeaningfulComment(uml::NamedElement element):
    !element.ownedComment.select(e|e.body.trim().length > 0).isEmpty;    
    
cached String getMarkdownComment(uml::NamedElement element):
    element.ownedComment.first().body.trim();
    
cached String getMarkdownCommentForTable(uml::NamedElement element):
    element.getMarkdownComment().replaceAll("\n", "
");

cached String getJavadocComment(uml::NamedElement element):
    element.getMarkdownComment().convertCommentForJavadoc();
    
cached String getJavadocCommentForParameter(uml::Parameter parameter):
    if parameter.hasMeaningfulJavadoc()
    then parameter.getMarkdownComment().convertCommentForJavadoc()
    else
        if parameter.type.ownedComment.selectFirst(e|e.isDefaultComment()) != null
        then parameter.type.ownedComment.selectFirst(e|e.isDefaultComment()).body.trim().convertCommentForJavadoc().replaceAll("\n", "
")
        else "";
    
cached boolean hasMeaningfulJavadoc(uml::NamedElement element):
    element.hasMeaningfulComment() || element.hasMeaningfulDeprecationInfo() || element.isAlias() || element.isBreakingChange();

cached boolean hasMeaningfulJavadocForProperty(uml::Property property):
    property.hasMeaningfulComment() || property.hasMeaningfulDeprecationInfo() || property.hasExample() || property.defaultValue != null || property.isSoftLink() || property.isAlias() || property.isBreakingChange();
    
cached String convertCommentForJavadoc(String comment):
    javaConvertCommentForJavadoc(comment);
    
private String javaConvertCommentForJavadoc(String comment):
    JAVA com.anaptecs.jeaf.fwk.generator.util.JavadocHelper.convertCommentForJavadoc(java.lang.String);