File: test_doc2.html

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 (139 lines) | stat: -rw-r--r-- 7,255 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
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
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
<?xml version="1.0"?>
<div class="body" role="main">
  <section id="namespace-Imagine\Draw">
    <span id="top-level-namespace"/>
    <h1>Top Level Namespace<a class="headerlink" href="#namespace-Imagine\Draw" title="Link to this heading">&#xB6;</a></h1>
    <p>namespace <code class="docutils literal notranslate"><span class="pre">Imagine\Draw</span></code></p>
    <dl class="php class">
      <dt class="sig sig-object php" id="Imagine\Draw\DrawerInterface">
        <em class="property">
          <span class="pre">class</span>
        </em>
        <span class="sig-prename descclassname">
          <span class="pre">Imagine\Draw\</span>
        </span>
        <span class="sig-name descname">
          <span class="pre">DrawerInterface</span>
        </span>
        <a class="headerlink" href="#Imagine\Draw\DrawerInterface" title="Link to this definition">&#xB6;</a>
      </dt>
      <dd/>
    </dl>
    <p>Instance of this interface is returned by <code class="xref php php-meth docutils literal notranslate"><span class="pre">ImagineImageImageInterface::draw</span></code>.</p>
    <dl class="php method">
      <dt class="sig sig-object php" id="Imagine\Draw\DrawerInterface::arc"><span class="sig-prename descclassname"><span class="pre">Imagine\Draw\DrawerInterface::</span></span><span class="sig-name descname"><span class="pre">arc</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="pre">PointInterface</span><span class="pre">$center</span></em>, <em class="sig-param"><span class="pre">BoxInterface</span><span class="pre">$size</span></em>, <em class="sig-param"><span class="pre">$start</span></em>, <em class="sig-param"><span class="pre">$end</span></em>, <em class="sig-param"><span class="pre">Color</span><span class="pre">$color</span></em><span class="sig-paren">)</span><a class="headerlink" href="#Imagine\Draw\DrawerInterface::arc" title="Link to this definition">&#xB6;</a></dt>
      <dd>
        <p>Draws an arc on a starting at a given x, y coordinates under a given start and end angles</p>
        <dl class="field-list simple">
          <dt class="field-odd">Parameters<span class="colon">:</span></dt>
          <dd class="field-odd">
            <ul class="simple">
              <li>
                <p><strong>$center</strong> (<span><code class="xref php php-obj docutils literal notranslate"><span class="pre">ImagineImagePointInterface</span></code></span>) &#x2013; Center of the arc.</p>
              </li>
              <li>
                <p><strong>$size</strong> (<span><code class="xref php php-obj docutils literal notranslate"><span class="pre">ImagineImageBoxInterface</span></code></span>) &#x2013; Size of the bounding box.</p>
              </li>
              <li>
                <p><strong>$start</strong> (<span><code class="xref php php-obj docutils literal notranslate"><span class="pre">integer</span></code></span>) &#x2013; Start angle.</p>
              </li>
              <li>
                <p><strong>$end</strong> (<span><code class="xref php php-obj docutils literal notranslate"><span class="pre">integer</span></code></span>) &#x2013; End angle.</p>
              </li>
              <li>
                <p><strong>$color</strong> (<span><code class="xref php php-obj docutils literal notranslate"><span class="pre">ImagineImageColor</span></code></span>) &#x2013; Line color.</p>
              </li>
            </ul>
          </dd>
          <dt class="field-even">Throws<span class="colon">:</span></dt>
          <dd class="field-even">
            <p>ImagineExceptionRuntimeException</p>
          </dd>
          <dt class="field-odd">Returns<span class="colon">:</span></dt>
          <dd class="field-odd">
            <p>ImagineDrawDrawerInterface</p>
          </dd>
        </dl>
      </dd>
    </dl>
    <section id="re-used-namespace">
      <h2>Re-used namespace<a class="headerlink" href="#re-used-namespace" title="Link to this heading">&#xB6;</a></h2>
      <p>No indexing errors or links should point to this namespace.</p>
      <dl class="php class">
        <dt class="sig sig-object php" id="LibraryName\ThirdClass">
          <em class="property">
            <span class="pre">class</span>
          </em>
          <span class="sig-prename descclassname">
            <span class="pre">LibraryName\</span>
          </span>
          <span class="sig-name descname">
            <span class="pre">ThirdClass</span>
          </span>
          <a class="headerlink" href="#LibraryName\ThirdClass" title="Link to this definition">&#xB6;</a>
        </dt>
        <dd>
          <p>Another class in a currentmodule block</p>
        </dd>
      </dl>
      <p>No indexing errors or links should point to this namespace.</p>
      <dl class="php class">
        <dt class="sig sig-object php" id="LibraryName\OtherClass">
          <em class="property">
            <span class="pre">class</span>
          </em>
          <span class="sig-prename descclassname">
            <span class="pre">LibraryName\</span>
          </span>
          <span class="sig-name descname">
            <span class="pre">OtherClass</span>
          </span>
          <a class="headerlink" href="#LibraryName\OtherClass" title="Link to this definition">&#xB6;</a>
        </dt>
        <dd>
          <p>Another class in a reused namespace</p>
        </dd>
      </dl>
      <dl class="php class">
        <dt class="sig sig-object php" id="LibraryName\Foo\Data\Thing">
          <em class="property">
            <span class="pre">class</span>
          </em>
          <span class="sig-name descname">
            <span class="pre">Foo\Data\Thing</span>
          </span>
          <a class="headerlink" href="#LibraryName\Foo\Data\Thing" title="Link to this definition">&#xB6;</a>
        </dt>
        <dd>
          <p>A class is with an absolute namespace.</p>
        </dd>
      </dl>
    </section>
    <section id="test-link-generation">
      <h2>Test link generation<a class="headerlink" href="#test-link-generation" title="Link to this heading">&#xB6;</a></h2>
      <p>
        <a class="reference internal" href="#Imagine\Draw\DrawerInterface" title="Imagine\Draw\DrawerInterface">
          <code class="xref php php-class docutils literal notranslate">
            <span class="pre">Imagine\Draw\DrawerInterface</span>
          </code>
        </a>
        <a class="reference internal" href="#LibraryName\OtherClass" title="LibraryName\OtherClass">
          <code class="xref php php-class docutils literal notranslate">
            <span class="pre">LibraryName\OtherClass</span>
          </code>
        </a>
        <a class="reference internal" href="#LibraryName\ThirdClass" title="LibraryName\ThirdClass">
          <code class="xref php php-class docutils literal notranslate">
            <span class="pre">LibraryName\ThirdClass</span>
          </code>
        </a>
        <a class="reference internal" href="#LibraryName\Foo\Data\Thing" title="LibraryName\Foo\Data\Thing">
          <code class="xref php php-class docutils literal notranslate">
            <span class="pre">Foo\Data\Thing</span>
          </code>
        </a>
      </p>
    </section>
  </section>
  <div class="clearer"/>
</div>