Constants

VISIBILITY_PUBLIC

VISIBILITY_PUBLIC = 1

VISIBILITY_PROTECTED

VISIBILITY_PROTECTED = 2

VISIBILITY_PRIVATE

VISIBILITY_PRIVATE = 4

VISIBILITY_INTERNAL

VISIBILITY_INTERNAL = 8

VISIBILITY_API

VISIBILITY_API = 16

VISIBILITY_DEFAULT

VISIBILITY_DEFAULT = 7 : int

Properties

$source

$source : \phpDocumentor\Configuration\Source

Type

Source

$output

$output : string

Type

string

$ignore

$ignore

$extensions

$extensions

$visibility

$visibility : string[]

Type

string[]

$defaultPackageName

$defaultPackageName : string

Type

string

$includeSource

$includeSource : bool

Type

bool

$markers

$markers : string[]

Type

string[]

$ignoreTags

$ignoreTags : string[]

Type

string[]

$examples

$examples : \phpDocumentor\Configuration\Source|null

Type

Source|null

$encoding

$encoding : string

Type

string

$validate

$validate : bool

Type

bool

Methods

createFromArray()

createFromArray(array  $api) : self

Parameters

array $api

Returns

self —

createDefault()

createDefault() : \phpDocumentor\Configuration\ApiSpecification

Returns

\phpDocumentor\Configuration\ApiSpecification —

withSource()

withSource(\phpDocumentor\Configuration\Source  $source) : self

Parameters

\phpDocumentor\Configuration\Source $source

Returns

self —

setIgnore()

setIgnore(array  $ignore) : void

Parameters

array $ignore

getIgnoredTags()

getIgnoredTags() : string[]

Returns

string[] —

calculateVisiblity()

calculateVisiblity() : int

Returns

int —

isVisibilityAllowed()

isVisibilityAllowed(int  $visibility) : bool

Checks whether the Project supports the given visibility.

Parameters

int $visibility

One of the VISIBILITY_* constants of the Settings class.

Returns

bool —

source()

source() : \phpDocumentor\Configuration\Source

Returns

\phpDocumentor\Configuration\Source —

__construct()

__construct(\phpDocumentor\Configuration\Source  $source, string  $output, array  $ignore, array  $extensions, string[]  $visibility, string  $defaultPackageName, bool  $includeSource, string[]  $markers, string[]  $ignoreTags, ?\phpDocumentor\Configuration\Source  $examples, string  $encoding, bool  $validate) : mixed

Parameters

\phpDocumentor\Configuration\Source $source
string $output
array $ignore
array $extensions
string[] $visibility
string $defaultPackageName
bool $includeSource
string[] $markers
string[] $ignoreTags
?\phpDocumentor\Configuration\Source $examples
string $encoding
bool $validate

Returns

mixed —