File: test_doc2.rst

package info (click to toggle)
sphinxcontrib-phpdomain 0.13.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 600 kB
  • sloc: python: 811; makefile: 153
file content (57 lines) | stat: -rw-r--r-- 1,416 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
Top Level Namespace
###################

namespace ``Imagine\Draw``

.. php:namespace:: Imagine\Draw

.. php:class:: DrawerInterface

Instance of this interface is returned by :php:meth:`Imagine\Image\ImageInterface::draw`.

.. php:method:: 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

Re-used namespace
=================

.. php:currentmodule:: LibraryName

No indexing errors or links should point to this namespace.

.. php:class:: ThirdClass

    Another class in a currentmodule block

.. php:currentnamespace:: LibraryName

No indexing errors or links should point to this namespace.

.. php:class:: OtherClass

    Another class in a reused namespace


.. php:class:: \Foo\Data\Thing

    A class is with an absolute namespace.


Test link generation
====================

:php:class:`Imagine\\Draw\\DrawerInterface`
:php:class:`LibraryName\\OtherClass`
:php:class:`LibraryName\\ThirdClass`
:php:class:`Foo\\Data\\Thing`