Home > Class Reference > %SYS namespace > %ZHSLIB.PackageManager.Developer.Annotation.Tag.Argument

%ZHSLIB.PackageManager.Developer.Annotation.Tag.Argument

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

SQL Table Name: %ZHSLIB_PackageManager_Developer_Annotation_Tag.Argument

tag for @Argument, used to document method arguments

Property Inventory (Including Private)

Method Inventory (Including Private)

Parameters

parameter MultiLineProperty = Documentation;
Inherited description: name of class property where the multiline content should be placed
parameter XMLNAME = ArgumentComment;
this tag serves only to carry documentation for the argument. Therefore we display its Documentation property as if it were the full content of the element, and we change the name to masquerade as the documentation.

Properties (Including Private)

property ArgumentName as %String (XMLPROJECTION = "none");
used during processing; when processing is done this tag object will be in the annotations collection of the argument proxy object, at which point this property is redundant.
Property methods: ArgumentNameDisplayToLogical(), ArgumentNameGet(), ArgumentNameGetStored(), ArgumentNameIsValid(), ArgumentNameLogicalToDisplay(), ArgumentNameLogicalToOdbc(), ArgumentNameNormalize(), ArgumentNameSet()
property Documentation as %String (MAXLEN = 2000, XMLPROJECTION = "content");
Property methods: DocumentationDisplayToLogical(), DocumentationGet(), DocumentationGetStored(), DocumentationIsValid(), DocumentationLogicalToDisplay(), DocumentationLogicalToOdbc(), DocumentationNormalize(), DocumentationSet()

Methods (Including Private)

private method HandleExtraContent(ByRef pCommentBlock As %Library.RawString, pContextObject As %ZHSLIB.PackageManager.Developer.Annotation.CosEntity.CommentableEntity) [ Language = objectscript ]
Inherited description: helper method for further content on the tag line after the tag itself. throws exceptions. expects the comment block to begin with the "remainder" after the initial tag has been removed, with the line break and anything preceding it still present. Leaves the block in a state with that remainder gone, and beginning with the next real line.

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.Argument)

^HS.PM.Dev.Annotation.AnchorTagD(ID,"Argument")
=
Documentation
ArgumentName