class KalimahApps / Daleel / ParseDocBlock

ParseDocBlock

Parse docblock data.
Extract summary, description, tags, paramaters .. etc

Properties

private

$docblock_data array

Docblock data

Default: []
private

$current_tag object

Reference to current tag.

Current tag

Default: null
private

$converter League\...\CommonMarkConverter

Reference to CommonMarkConverter object.

CommonMarkConverter object

Default: null
private

$uses array

Array of uses in current file

Default: null

Methods

public

__construct ( phpDocumentor\...\DocBlock $docblock , array $uses ) : void

Initiate docblock parsing.

Parameters

  • $docblock phpDocumentor\...\DocBlock
    Docblock object
  • $uses array
    Array of uses in current file
private

processDefaultTag ( ) : void

Default tag processor.

private

resolveType ( string $type ) : string

Attempt to resolve type from the list of uses.

Parameters

  • $type string
    Type to resolve
private

getDescription ( ) : void

Get converted description.

private

unwrapParagraphs ( string $description ) : void

Remove <p> and </p> tags from description.

Parameters

  • $description string
    Description
private

processParamTag ( ) : void

Process @param tag.

private

processExampleTag ( ) : void

Process @example tag.

private

processVarReturnThrowsTag ( ) : void

Process @var, @return, @throws tags.

private

processDeprecatedTag ( ) : void

Process @deprecated tag.

private

processDescriptionTag ( ) : void

Process @internal, @ignore, @access tags.

private

processLinkTag ( ) : void

Process @link tag.

private

processSeeTag ( ) : void

Process @see tag.

public

getParsedDocblockData ( ) : array

Get docblock data after parsing.