Class CompletionDescriptorRenderer
java.lang.Object
com.inductiveautomation.ignition.designer.ai.tool.CompletionDescriptorRenderer
Renders
CompletionDescriptors as plain-text documentation — a symbol's signature,
parameters, return type, throws, members, and deprecation — for AI tool responses and
@-reference bodies.-
Method Summary
Modifier and TypeMethodDescriptionstatic Stringdescribe(com.inductiveautomation.ignition.common.script.typing.CompletionDescriptor symbol) static StringsummarizeMembers(com.inductiveautomation.ignition.common.script.typing.TypeDescriptor type) Renders one line per member declared directly ontype— every method and attribute with its signature and description, methods first, each group in name order.
-
Method Details
-
describe
public static String describe(com.inductiveautomation.ignition.common.script.typing.CompletionDescriptor symbol) -
summarizeMembers
public static String summarizeMembers(com.inductiveautomation.ignition.common.script.typing.TypeDescriptor type) Renders one line per member declared directly ontype— every method and attribute with its signature and description, methods first, each group in name order. Deprecated members are omitted entirely.The summary is flat: a nested package contributes its name alone, so a caller that needs what is inside one summarizes that package in turn.
- Returns:
- the member lines, each newline-terminated, or the empty string when
typedeclares no members that survive the deprecation filter.
-