Phpdomain

Quick Sample

This is source:

..  php:class:: \Vendor\Extension\Namespace\SomeDateClass

    SomeDateClass class

    ..  php:method:: setDate($year, $month, $day)

        Set the date.

        :param int $year: The year.
        :param int $month: The month.
        :param int $day: The day.
        :returns: Either false on failure, or the datetime object for method chaining.


    ..  php:method:: setTime($hour, $minute[, $second])

        Set the time.

        :param int $hour: The hour
        :param int $minute: The minute
        :param int $second: The second
        :returns: Either false on failure, or the datetime object for method chaining.

    ..  php:const:: ATOM

        Y-m-d\TH:i:sP

class SomeDateClass

Fully qualified name: \Vendor\Extension\Namespace\SomeDateClass

SomeDateClass class

setDate ( $year, $month, $day)

Set the date.

param int $year: The year.
param int $month: The month.
param int $day: The day.

Returns: Either false on failure, or the datetime object for method chaining.

setTime ( $hour, $minute[, $second])

Set the time.

param int $hour: The hour
param int $minute: The minute
param int $second: The second

Returns: Either false on failure, or the datetime object for method chaining.

const ATOM: Y-m-dTH:i:sP

Acceptance tests for PHPdomain

Credit: The source for this section was taken from the original GitHub repository markstory/sphinxcontrib-phpdomain.

Classes

class DateTime

DateTime class

setDate ( $year, $month, $day)

Set the date in the datetime object

param int $year: The year.
param int $month: The month.
param int $day: The day.

setTime ( $hour, $minute[, $second])

Set the time

param int $hour: The hour
param int $minute: The minute
param int $second: The second

public static getLastErrors ( )

Returns the warnings and errors

Returns: array Returns array containing info about warnings and errors.

const ATOM: Y-m-d\TH:i:sP

testattr: Value of some attribute

class OtherClass

Another class

update ( $arg = '', $arg2 = [], $arg3 = []): Update something.

nonIndentedAttribute: This attribute wasn't indented

const NO_INDENT: This class constant wasn't indented

static staticMethod ( ): A static method.

Exceptions

exception InvalidArgumentException: Throw when you get an argument that is bad.

Interfaces

interface DateTimeInterface

Datetime interface

setDate ( $year, $month, $day)

Set the date in the datetime object

param int $year: The year.
param int $month: The month.
param int $day: The day.

setTime ( $hour, $minute[, $second])

Set the time

param int $hour: The hour
param int $minute: The minute
param int $second: The second

const ATOM: Y-m-dTH:i:sP

testattr: Value of some attribute

interface OtherInterface: Another interface

Traits

trait LogTrait

A logging trait

log ( $level, $string): A method description.

Test Case - Global symbols with no namespaces

DateTime

DateTime::setTime()

DateTime::getLastErrors()

OtherClass::$nonIndentedAttribute

OtherClass::NO_INDENT

OtherClass::staticMethod

InvalidArgumentException

DateTimeInterface

DateTimeInterface::setTime()

~DateTimeInterface::setDate()

DateTimeInterface::ATOM

DateTimeInterface::$testattr

OtherInterface

LogTrait

LogTrait::log()

Namespaced elements

exception NamespaceException

Fully qualified name: \LibraryName\NamespaceException

This exception is in a namespace.

class LibraryClass

Fully qualified name: \LibraryName\LibraryClass

A class in a namespace

instanceMethod ( $foo): An instance method

const TEST_CONST: Test constant

property: A property!

static staticMethod ( ): A static method in a namespace

class NamespaceClass

Fully qualified name: \LibraryName\NamespaceClass

A class in the namespace, no indenting on children

firstMethod ( $one, $two): A normal instance method.

property: A property

const NAMESPACE_CONST: Const on class in namespace

static namespaceStatic ( $foo): A static method here.

final class LibraryClassFinal

Fully qualified name: \LibraryName\LibraryClassFinal

A final class

public firstMethod ( $one, $two): A public instance method.

protected secondMethod ( $one, $two): A protected instance method.

private thirdMethod ( $one, $two): A private instance method.

static fourthMethod ( $one, $two): A static method.

final protected final fifthMethod ( $one, $two): A protected final method.

abstract class LibraryClassAbstract

Fully qualified name: \LibraryName\LibraryClassAbstract

An abstract class

interface LibraryInterface

Fully qualified name: \LibraryName\LibraryInterface

A interface in a namespace

instanceMethod ( $foo): An instance method

trait TemplateTrait

Fully qualified name: \LibraryName\TemplateTrait

A trait in a namespace

render ( $template): Render a template.

Test Case - not including namespace

LibraryName

\LibraryName\LibraryClass

LibraryName\LibraryClass::instanceMethod

LibraryName\LibraryClass::staticMethod()

LibraryName\LibraryClass::$property

LibraryName\LibraryClass::TEST_CONST

\LibraryName\NamespaceClass

\LibraryName\NamespaceClass::firstMethod

\LibraryName\NamespaceClass::$property

\LibraryName\NamespaceClass::NAMESPACE_CONST

\LibraryName\LibraryClassFinal

\LibraryName\LibraryClassFinal::firstMethod

\LibraryName\LibraryClassFinal::secondMethod

\LibraryName\LibraryClassFinal::thirdMethod

\LibraryName\LibraryClassFinal::fourthMethod

\LibraryName\LibraryClassFinal::fifthMethod

\LibraryName\LibraryInterface

\LibraryName\LibraryInterface::instanceMethod

\LibraryName\NamespaceException

\LibraryName\TemplateTrait

LibraryName\\TemplateTrait::render()

Test Case - global access

DateTime

DateTime::setTime()

LibraryName\\LibraryClass::$property

LibraryName\\LibraryClass::TEST_CONST

DateTimeInterface

DateTimeInterface::setTime()

Any Cross Ref

LibraryName\SubPackage\NestedNamespaceException

DateTimeInterface::$testattr

Nested namespaces

exception NestedNamespaceException

Fully qualified name: \LibraryName\SubPackage\NestedNamespaceException

In a package

class SubpackageClass

Fully qualified name: \LibraryName\SubPackage\SubpackageClass

A class in a subpackage

interface SubpackageInterface

Fully qualified name: \LibraryName\SubPackage\SubpackageInterface

A class in a subpackage

Test Case - Test subpackage links

LibraryName\SubPackage

\LibraryName\SubPackage\SubpackageClass

\LibraryName\SubPackage\SubpackageInterface

\LibraryName\SubPackage\NestedNamespaceException

Return Types

class ReturningClass

Fully qualified name: \OtherLibrary\ReturningClass

A class to do some returning.

returnClassFromSameNamespace ( )

returntype: OtherLibrary\\ReturnedClass

Returns: An object instance of a class from the same namespace.

returnClassFromOtherNamespace ( )

returntype: LibraryName\\SubPackage\\SubpackageInterface

Returns: An object instance of a class from another namespace.

returnClassConstant ( )

returntype: LibraryName\\NamespaceClass::NAMESPACE_CONST

Returns: The value of a specific class constant.

returnGlobalConstant ( )

returntype: SOME_CONSTANT

Returns: The value of a specific global constant.

returnExceptionInstance ( )

returntype: InvalidArgumentException

Returns: An instance of an exception.

returnScalarType ( )

returntype: string

Returns: A scalar string type.

returnUnionType ( )

returntype: int|string|OtherLibrary\\ReturnedClass|LibraryName\\SubPackage\\SubpackageInterface|null

Returns: Any of a whole bunch of things specified with a PHP 8 union type.

class ReturnedClass

Fully qualified name: \OtherLibrary\ReturnedClass

A class to return.

Top Level Namespace

Credit: The source for this section was taken from the original GitHub repository markstory/sphinxcontrib-phpdomain.

namespace Imagine\Draw

class DrawerInterface

Fully qualified name: \Imagine\Draw\DrawerInterface

Instance of this interface is returned by.

arc ( PointInterface $center, BoxInterface $size, $start, $end, Color $color)

Draws an arc on a starting at a given x, y coordinates under a given start and end angles

param Imagine\Image\PointInterface $center: Center of the arc.
param Imagine\Image\BoxInterface $size: Size of the bounding box.
param integer $start: Start angle.
param integer $end: End angle.
param Imagine\Image\Color $color: Line color.
throws: Imagine\Exception\RuntimeException

Returns: Imagine\Draw\DrawerInterface