Class DocumentationGenerator

Net\Bazzline\Component\CodeGenerator\AbstractBasicGenerator implements Net\Bazzline\Component\CodeGenerator\GeneratorInterface

Net\Bazzline\Component\CodeGenerator\AbstractGenerator implements Net\Bazzline\Component\CodeGenerator\BlockGeneratorDependentInterface, Net\Bazzline\Component\CodeGenerator\LineGeneratorDependentInterface

Net\Bazzline\Component\CodeGenerator\DocumentationGenerator

Namespace: Net\Bazzline\Component\CodeGenerator
Package: Net\Bazzline\Component\Locator\LocatorGenerator\Generator
See: http://www.phpdoc.org/docs/latest/index.html
Located at DocumentationGenerator.php

Methods summary
`public`	# `addComment( string $comment )` Parameters `$comment` Returns $this
`public`	# `setClass( string $className )` Parameters `$className` Returns $this
`public`	# `setInterface( $interfaceName )` Parameters `$interfaceName` Returns $this
`public`	# `setPackage( string $package )` Parameters `$package` Returns $this
`public`	# `addParameter( string $name, array $typeHints = [], string $comment = '' )` Parameters `$name` `$typeHints` `$comment` Returns $this
`public`	# `setReturn( array $typeHints, string $comment = '' )` Parameters `$typeHints` `$comment` Returns $this
`public`	# `addSee( string $see )` Parameters `$see` Returns $this
`public`	# `addThrows( string $exception )` Parameters `$exception` Returns $this
`public`	# `addTodoS( string $toDo )` Parameters `$toDo` Returns $this
`public`	# `setAuthor( string $name, string $email = '' )` Parameters `$name` `$email` Returns $this
`public`	# `setVariable( string $name, array $typeHints = [] )` Parameters `$name` `$typeHints` Returns $this
`public`	# `setVersion( string $number, string $description = '' )` Parameters `$number` `$description` Returns $this See http://www.phpdoc.org/docs/latest/for-users/phpdoc/tags/version.html
`public string`	# `generate( )` Returns string Throws `Net\Bazzline\Component\CodeGenerator\InvalidArgumentException`\|`Net\Bazzline\Component\CodeGenerator\RuntimeException`

Methods inherited from Net\Bazzline\Component\CodeGenerator\AbstractGenerator
`__clone(), __construct(), addContent(), addGeneratorAsContent(), addGeneratorProperty(), canBeGenerated(), clear(), generateStringFromContent(), getBlockGenerator(), getGeneratorProperty(), getLastArrayKey(), getLineGenerator(), getNotPrintableTypeHints(), hasContent(), markAsCanBeGenerated(), resetContent(), setBlockGenerator(), setIndention(), setLineGenerator()`

Methods inherited from Net\Bazzline\Component\CodeGenerator\AbstractBasicGenerator
`__toString(), getIndention()`

Namespaces

Classes

Interfaces

Exceptions

Class DocumentationGenerator

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

See

Returns

Throws