File: usage.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 (82 lines) | stat: -rw-r--r-- 1,724 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
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
Usage Example
=============

This is source:

.. code:: rst

  .. 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
   :nocontentsentry:

   Datetime class

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

      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])
      :nocontentsentry:

      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
      :nocontentsentry:

      Y-m-d\TH:i:sP

Cross referencing
-----------------

From other place, you can create cross reference like that:

.. code:: rst

   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`.