%ZHSLIB.PackageManager.Developer.Annotation.Tag.ReturnValue

persistent class %ZHSLIB.PackageManager.Developer.Annotation.Tag.ReturnValue extends %ZHSLIB.PackageManager.Developer.Annotation.Tag.Multiline

SQL Table Name: %ZHSLIB_PackageManager_Developer_Annotation_Tag.ReturnValue

tag for @ReturnValue, for documenting method return values

Property Inventory (Including Private)

Parameters

parameter MultiLineProperty = Documentation;
Inherited description: name of class property where the multiline content should be placed
parameter XMLNAME = ReturnValueComment;
Inherited description: note that we tried using a COSEXPRESSION to generate the XMLNAME from the class name, using the obvious simple rule: $replace($piece($classname(),".",6,*),".","_") . While this works when evaluated with $parameter(), the XML writer can't use it because it relies on run-time expression execution and the XML output is done via generated code. Using a curly-braces "evaluate at compile time" expression also does not work, even if we use %classname instead of $classname(); maybe the XML.Adaptor code generation doesn't support the {} syntax regardless. See prodlog 148118 So we have to provide the obvious XMLNAME value explicitly in all the tag subclasses.

Properties

property Documentation as %String (MAXLEN = 2000, XMLPROJECTION = "content");
Property methods: DocumentationDisplayToLogical(), DocumentationGet(), DocumentationGetStored(), DocumentationIsValid(), DocumentationLogicalToDisplay(), DocumentationLogicalToOdbc(), DocumentationNormalize(), DocumentationSet()

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)

Storage

Gray indicates storage defined by superclasses.

Storage Model: Storage (%ZHSLIB.PackageManager.Developer.Annotation.Tag.AnchorTag)

^HS.PM.Dev.Annotation.AnchorTagD(ID)
=
%%CLASSNAME
ParentCosEntity
Inherited

Storage Model: Storage (%ZHSLIB.PackageManager.Developer.Annotation.Tag.ReturnValue)

^HS.PM.Dev.Annotation.AnchorTagD(ID,"ReturnValue")
=
Documentation
Feedback