Class DocCommentNode

A doc comment.

Pharborist\Node implements Pharborist\NodeInterface

Extended by

Pharborist\TokenNode

Extended by

Pharborist\HiddenNode

Extended by

Pharborist\CommentNode uses Pharborist\UncommentTrait

Extended by

Pharborist\DocCommentNode

Namespace: Pharborist
Located at DocCommentNode.php

Methods summary
`public static Pharborist\DocCommentNode`	# `create( string $comment )` Creates a PHPDoc comment. Creates a PHPDoc comment. Parameters `$comment` The comment body without asterisks, but formatted into lines. Returns `Pharborist\DocCommentNode` Overrides `Pharborist\CommentNode::create()`
`public`	# `setIndent( string $indent )` Set indent for document comment. Set indent for document comment. Parameters `$indent` Whitespace to use as indent. Returns $this
`public`	# `setText( string $text )` Parameters `$text` Returns $this Overrides `Pharborist\TokenNode::setText()`
`public phpDocumentor\Reflection\DocBlock`	# `getDocBlock( )` Return the parsed doc comment. Return the parsed doc comment. Returns phpDocumentor\Reflection\DocBlock Parsed doc comment.
`public string`	# `getShortDescription( )` Get the opening line or also known as short description. Get the opening line or also known as short description. Returns string Short description.
`public string.`	# `getLongDescription( )` Get the full description or also known as long description. Get the full description or also known as long description. Returns string. Long description.
`public phpDocumentor\Reflection\DocBlock\Tag\ReturnTag`	# `getReturn( )` Get the return tag. Get the return tag. Returns phpDocumentor\Reflection\DocBlock\Tag\ReturnTag Return tag.
`public phpDocumentor\Reflection\DocBlock\Tag\ParamTag`	# `getParameters( )` Get the parameter tags. Get the parameter tags. Returns phpDocumentor\Reflection\DocBlock\Tag\ParamTag Array of parameter tags.
`public phpDocumentor\Reflection\DocBlock\Tag\ParamTag`	# `getParametersByName( )` Get the parameter tags by name. Get the parameter tags by name. Returns phpDocumentor\Reflection\DocBlock\Tag\ParamTag Associative array of parameter names to parameters.
`public null\|phpDocumentor\Reflection\DocBlock\Tag\ParamTag`	# `getParameter( $parameterName )` Get a parameter tag. Get a parameter tag. Parameters `$parameterName` of parameter to get tag for. Returns null\|phpDocumentor\Reflection\DocBlock\Tag\ParamTag The tag for parameter.

Methods inherited from Pharborist\CommentNode
`__construct(), getCommentText(), getCommentType(), isLineComment()`

Methods inherited from Pharborist\TokenNode
`__toString(), getSourcePosition(), getText(), getType(), getTypeName(), typeName()`

Methods inherited from Pharborist\Node
`__clone(), after(), appendTo(), before(), closest(), fromValue(), furthest(), getLogicalBlock(), getRoot(), getStatement(), hasRoot(), index(), insertAfter(), insertBefore(), is(), isAllOf(), isAnyOf(), next(), nextAll(), nextToken(), nextUntil(), parent(), parents(), parentsUntil(), prependTo(), previous(), previousAll(), previousToken(), previousUntil(), remove(), replaceAll(), replaceWith(), siblings(), sortKey(), swapWith()`

Methods used from Pharborist\UncommentTrait
`uncomment()`

Constants inherited from Pharborist\CommentNode
`BLOCK, DOC, HASH, SINGLE`