DocParser Class Reference

Public Member Functions
	__construct ($content, DocFormater $formater=null)
	parse ()
	isEmpty ()
	getDescription ()
	getPart ($partKey)
	getDescriptionAsHtml ($separator="<br>")
	getMethodParams ()
	getMethodParamsReturn ()
	getMethodReturn ()
	getMethodParamsAsHtml ($separator=NULL)
	getMethodParamsReturnAsHtml ($separator=NULL)
	getMethodReturnAsHtml ($separator="<br>")
	getElementsAsHtml ($elements, $separator="<br>")

Static Public Member Functions
static	docClassParser ($classname)
static	docMethodParser ($classname, $method)

Private Member Functions
	addInArray (&$array, $key, $value)

Private Attributes
	$originalContent
	$lines
	$description
	$formater

Detailed Description

Definition at line 16 of file DocParser.php.

Constructor & Destructor Documentation

__construct()

__construct	(		$content,
		DocFormater	$formater = null
	)

Definition at line 25 of file DocParser.php.

Member Function Documentation

addInArray()

addInArray ( &  $array,   $key,   $value  )

private

Definition at line 55 of file DocParser.php.

docClassParser()

static docClassParser (   $classname )

static

Definition at line 121 of file DocParser.php.

docMethodParser()

static docMethodParser (   $classname,   $method  )

static

Definition at line 128 of file DocParser.php.

getDescription()

getDescription

(

)

Definition at line 62 of file DocParser.php.

getDescriptionAsHtml()

getDescriptionAsHtml

(

$separator = "<br>"

)

Definition at line 72 of file DocParser.php.

getElementsAsHtml()

getElementsAsHtml	(		$elements,
			$separator = "<br>"
	)

Definition at line 111 of file DocParser.php.

getMethodParams()

getMethodParams

(

)

Definition at line 84 of file DocParser.php.

getMethodParamsAsHtml()

getMethodParamsAsHtml

(

$separator = NULL

)

Definition at line 96 of file DocParser.php.

getMethodParamsReturn()

getMethodParamsReturn

(

)

Definition at line 88 of file DocParser.php.

getMethodParamsReturnAsHtml()

getMethodParamsReturnAsHtml

(

$separator = NULL

)

Definition at line 100 of file DocParser.php.

getMethodReturn()

getMethodReturn

(

)

Definition at line 92 of file DocParser.php.

getMethodReturnAsHtml()

getMethodReturnAsHtml

(

$separator = "<br>"

)

Definition at line 106 of file DocParser.php.

getPart()

getPart

(

$partKey

)

Definition at line 66 of file DocParser.php.

isEmpty()

isEmpty

(

)

Definition at line 51 of file DocParser.php.

parse()

parse

(

)

Definition at line 31 of file DocParser.php.

Field Documentation

$description

$description

private

Definition at line 19 of file DocParser.php.

$formater

$formater

private

Definition at line 23 of file DocParser.php.

$lines

$lines

private

Definition at line 18 of file DocParser.php.

$originalContent

$originalContent

private

Definition at line 17 of file DocParser.php.

---

The documentation for this class was generated from the following file:

• C:/Users/myadd/Documents/GitHub/ubiquity-doc-api/vendor/phpmv/ubiquity-dev/src/Ubiquity/annotations/parser/DocParser.php