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
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
|
PHP Domain
##########
:author: Mark Story <mark at mark-story.com>
About
=====
A domain for sphinx >= 1.0 that provides language support for PHP.
PHP Domain supports following objects:
* Global variable
* Global function
* Constant
* Namespace
* Function
* Class
* Class
* Class constant
* Instance methods
* Static methods
* Properties
.. note::
This domain expresses methods and attribute names like this::
Class::method_name
Class::$attribute_name
You address classes/functions in namespaces using \\ syntax as you would in PHP::
Package\Subpackage\Class
URLs
====
:PyPI: http://pypi.python.org/pypi/sphinxcontrib-phpdomain
:Detail Document: http://packages.python.org/sphinxcontrib-phpdomain
Quick Sample
============
This is source::
.. php:class:: DateTime
Datetime 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
Result
-----------------
.. php:class:: DateTime
Datetime 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
Cross referencing
-----------------
From other place, you can create cross reference like that::
You can modify a DateTime's date using :php:meth:`DateTime::setDate`.
Result
-----------
You can modify a DateTime's date using :php:meth:`DateTime::setDate`.
Install
=======
You can install the phpdomain using easy_install::
easy_install -U sphinxcontrib-phpdomain
|
