functions.Javadoc.xpt Maven / Gradle / Ivy
«EXTENSION functions::Javadoc»
«EXTENSION functions::JEAFDeprecated»
«EXTENSION functions::BreakingChange»
«EXTENSION functions::Operation»
«EXTENSION functions::Alias»
«EXTENSION functions::SoftLink»
«EXTENSION functions::Example»
«EXTENSION functions::DefaultComment»
«EXTENSION java::Naming»
«EXTENSION entity::ModelProperties»
«EXTENSION java::GeneratorCommons»
«DEFINE JavadocForType FOR uml::NamedElement»
«IF this.hasMeaningfulJavadoc()»
/**
«EXPAND AddComment -»
«EXPAND AliasJavadoc -»
«EXPAND BreakingChangeJavadoc -»
* @author «getAuthor()»
* @version «getVersion()»
«EXPAND DeprecatedJavadoc -»
*/
«ENDIF»
«ENDDEFINE»
«DEFINE JavadocForOperation FOR uml::Operation»
/**
«EXPAND AddComment -»
«EXPAND SecurityRolesComment -»
«EXPAND BreakingChangeJavadoc -»
«FOREACH this.getInputParameters() AS param -»
* @param «param.name» «param.getJavadocCommentForParameter()» «IF param.isJEAFDeprecated()»
Deprecated. «param.getDeprecationDescriptionForJavadoc()» (since: «param.getDeprecatedSince()», removed with: «param.getDeprecationRemoval()»)«ENDIF»
«EXPAND BreakingChangeJavadoc FOR param-»
«ENDFOREACH -»
«IF this.hasReturnType() && this.getReturnTypeName() != "void" -»
«LET this.getReturnType() AS returnType -»
* @return «IF this.returnsPrimitiveType() == false»{@link «ENDIF»«this.getReturnTypeName()»«IF this.returnsPrimitiveType() == false»}«ENDIF» «returnType.getJavadocCommentForParameter()» «IF returnType.isJEAFDeprecated()»
Deprecated. «returnType.getDeprecationDescriptionForJavadoc()» (since: «returnType.getDeprecatedSince()», removed with: «returnType.getDeprecationRemoval()»)«ENDIF»
«EXPAND BreakingChangeJavadoc FOR returnType -»
«ENDLET-»
«ENDIF -»
«EXPAND DeprecatedJavadoc -»
*/
«ENDDEFINE»
«DEFINE JavadocForProperty FOR uml::Property»
«IF this.hasMeaningfulJavadocForProperty()»
/**
«EXPAND AddComment -»
«IF this.isSoftLink() -»
* This class uses so called soft links for decoupling. The actual type that is hidden by {@link #«asInstanceVar()»} is «type.fqn()»
«ENDIF -»
«IF this.defaultValue != null -»
Default Value: «this.initValue()»
«ENDIF -»
«IF this.hasExample() -»
«IF this.asExample().hasExampleValue() -»
Example(s):
«FOREACH this.asExample().exampleValues AS exampleValue»«exampleValue»
«ENDIF -»
«ENDIF -»
«EXPAND AliasJavadoc -»
«EXPAND RESTDocs -»
«EXPAND BreakingChangeJavadoc -»
«EXPAND DeprecatedJavadoc -»
*/
«ENDIF»
«ENDDEFINE»
«DEFINE JavadocForPropertyGetter FOR uml::Property»
/**
* Method returns «IF this.association == null»attribute«ELSE»association«ENDIF» {@link #«asInstanceVar()»}.
«IF this.isSoftLink() -»
* This class uses so called soft links for decoupling. The actual type that is hidden by {@link #«asInstanceVar()»} is «type.fqn()»
«ENDIF -»
«EXPAND AddComment -»
«EXPAND BreakingChangeJavadoc -»
«IF this.isSoftLink() == false -»
* @return «IF type.isPrimitiveType() == false»{@link «this.fqn()»}«ELSE»«this.fqn()»«ENDIF» Value to which {@link #«asInstanceVar()»} is set.
«ELSE -»
* @return {@link «IF this.isMultivalued()»«this.getCollectionType()»<«((JMM::SoftLink)this).getJavaSoftLinkType()»>«ELSE»«((JMM::SoftLink)this).getJavaSoftLinkType()»«ENDIF»} Value to which {@link #«asInstanceVar()»} is set.
«ENDIF -»
«IF this.association != null && this.isMultivalued() -»
The method never returns null and the returned collection is «IF disableCollectionImmutability()»modifiable«ELSE»unmodifiable«ENDIF».
«ENDIF -»
«EXPAND DeprecatedJavadoc -»
*/
«ENDDEFINE»
«DEFINE JavadocForPropertyUnset FOR uml::Property»
/**
* Method unsets {@link #«asInstanceVar()»}.
*/
«ENDDEFINE»
«DEFINE JavadocForPropertyAdd FOR uml::Property»
/**
* Method adds the passed object to {@link #«asInstanceVar()»}.
«EXPAND BreakingChangeJavadoc -»
*
* @param «asParameter()» Object that should be added to {@link #«asInstanceVar()»}. The parameter must not be null.
«EXPAND DeprecatedJavadoc -»
*/
«ENDDEFINE»
«DEFINE JavadocForPropertyAddAll FOR uml::Property»
/**
* Method adds all passed objects to {@link #«asInstanceVar()»}.
«EXPAND BreakingChangeJavadoc -»
*
* @param «asParameter()» Collection with all objects that should be added to {@link #«asInstanceVar()»}. The parameter must not be null.
«EXPAND DeprecatedJavadoc -»
*/
«ENDDEFINE»
«DEFINE JavadocForPropertySetter FOR uml::Property»
/**
* Method sets «IF this.association == null»attribute«ELSE»association«ENDIF» {@link #«asInstanceVar()»}.
«EXPAND functions::Javadoc::AddComment -»
«EXPAND BreakingChangeJavadoc -»
* @param «asParameter()» Value to which {@link #«asInstanceVar()»} should be set.
«EXPAND DeprecatedJavadoc -»
*/
«ENDDEFINE»
«DEFINE JavadocForBuilderSetter(String builderClassName) FOR uml::Property»
/**
* Method sets «IF this.association == null»attribute«ELSE»association«ENDIF» {@link #«asInstanceVar()»}.
«EXPAND BreakingChangeJavadoc -»
* @param «asParameter()» «IF type.isPrimitiveType() || this.isMultivalued() == false»Value«ELSE»Collection«ENDIF» to which {@link #«asInstanceVar()»} should be set.
* @return {@link «builderClassName»} Instance of this builder to support chaining setters. Method never returns null.
«EXPAND DeprecatedJavadoc -»
*/
«ENDDEFINE»
«DEFINE JavadocForBuilderAddTo(String builderClassName) FOR uml::Property»
/**
* Method adds the passed objects to association {@link #«asInstanceVar()»}.
«EXPAND BreakingChangeJavadoc -»
* @param «asParameter()» Array of objects that should be added to {@link #«asInstanceVar()»}. The parameter may be null.
* @return {@link «builderClassName»} Instance of this builder to support chaining. Method never returns null.
«EXPAND DeprecatedJavadoc -»
*/
«ENDDEFINE»
«DEFINE JavadocForBuilderVarArgsSetter(String builderClassName) FOR uml::Property»
/**
* Method sets «IF this.association == null»attribute«ELSE»association«ENDIF» {@link #«asInstanceVar()»}.
«EXPAND BreakingChangeJavadoc -»
* @param «asParameter()» Array with objects to which {@link #«asInstanceVar()»} should be set.
* @return {@link «builderClassName»} Instance of this builder to support chaining setters. Method never returns null.
«EXPAND DeprecatedJavadoc -»
*/
«ENDDEFINE»
«DEFINE JavadocForLiteral FOR uml::EnumerationLiteral»
«IF this.hasMeaningfulJavadoc()»
/**
«EXPAND AddComment -»
«EXPAND AliasJavadoc -»
«EXPAND BreakingChangeJavadoc -»
«EXPAND DeprecatedJavadoc -»
*/
«ENDIF»
«ENDDEFINE»
«DEFINE AddComment FOR uml::NamedElement -»
«FOREACH ownedComment.select(e|e.isDefaultComment() == false) AS comment SEPARATOR "" -»
«comment.body.trim().convertCommentForJavadoc()»
«ENDFOREACH -»«ENDDEFINE»
«DEFINE SecurityRolesComment FOR uml::Operation -»
«IF generateSecurityAnnotation() && hasSecurityRoles() -»
Authorized Roles: «FOREACH this.getSecurityRolesForDocumentation() AS role SEPARATOR ", "»«role»«ENDFOREACH»
«ENDIF -»
«ENDDEFINE»
«DEFINE DeprecatedJavadoc FOR uml::NamedElement -»
«IF this.isJEAFDeprecated() && this.hasMeaningfulDeprecationInfo() -»
* @deprecated «this.getDeprecationDescriptionForJavadoc()» (since: «IF this.getDeprecatedSince().length > 0»«this.getDeprecatedSince()»«ELSE»TBD«ENDIF», removed with: «IF this.getDeprecationRemoval().length > 0»«this.getDeprecationRemoval()»«ELSE»TBD«ENDIF»)
«ENDIF-»
«ENDDEFINE»
«DEFINE BreakingChangeJavadoc FOR uml::NamedElement -»
«IF this.isBreakingChange()-»
Breaking Change with «this.getBreakingChangeActiveWith()»: «this.getBreakingChangeDescription().convertCommentForJavadoc()»
«ENDIF-»
«ENDDEFINE»
«DEFINE AliasJavadoc FOR uml::NamedElement -»
«IF this.isAlias()-»
Alternate Name: «this.asAlias().getAlternateNameForJavadoc()»
«ENDIF-»
«ENDDEFINE»
«DEFINE RESTDocs FOR uml::Property -»
«IF isTargetRuntimeSpring() -»
«IF this.isStereotypeApplied("PathParam") -»
Path-Param: «EXPAND java::OpenAPI::RESTParamName»
«ENDIF -»
«IF this.isStereotypeApplied("HeaderParam") -»
Header-Param: «EXPAND java::OpenAPI::RESTParamName»
«ENDIF -»
«ENDIF -»
«ENDDEFINE»