Modifier | Constructor and Description |
---|---|
protected |
CommentRule() |
Modifier and Type | Method and Description |
---|---|
com.sun.codemodel.JDocComment |
apply(String nodeName,
com.fasterxml.jackson.databind.JsonNode node,
com.fasterxml.jackson.databind.JsonNode parent,
com.sun.codemodel.JDocCommentable generatableType,
Schema schema)
Applies this schema rule to take the required code generation steps.
|
public com.sun.codemodel.JDocComment apply(String nodeName, com.fasterxml.jackson.databind.JsonNode node, com.fasterxml.jackson.databind.JsonNode parent, com.sun.codemodel.JDocCommentable generatableType, Schema schema)
When a $comment node is found and applied with this rule, the value of the $comment is added as a method and field level JavaDoc comment.
apply
in interface Rule<com.sun.codemodel.JDocCommentable,com.sun.codemodel.JDocComment>
nodeName
- the name of the object to which this description appliesnode
- the "$comment" schema nodeparent
- the parent nodegeneratableType
- comment-able code generation construct, usually a java class,
which should have this description appliedschema
- the schema to which this schema rule (and the given node)
belongs.Copyright © 2022. All rights reserved.