File: Counter.xml

package info (click to toggle)
phpdox 0.12.0-6
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, sid
  • size: 7,672 kB
  • sloc: xml: 80,724; php: 9,167; makefile: 13
file content (52 lines) | stat: -rw-r--r-- 2,404 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
 
<?xml version="1.0" encoding="UTF-8" ?>
<class xmlns="http://xml.phpdox.net/src" full="Counter" namespace="" name="Counter">
  <constructor name="__construct" abstract="false" static="false" final="false">
    <docblock>
      <description compact="&#10;      Creates an instance of a Counter which maintains a single numeric value&#10;     "/>
      <return type="void"/>
    </docblock>
    <parameter name="name" optional="false" byreference="false" type="string"/>
    <parameter name="initial_value" optional="true" byreference="false" type="int"/>
    <parameter name="flags" optional="true" byreference="false" type="int"/>
  </constructor>
  <method name="getValue" abstract="false" static="false" final="false">
    <docblock>
      <description compact="&#10;      Get the current value of a counter&#10;     "/>
      <return type="int"/>
    </docblock>
  </method>
  <method name="bumpValue" abstract="false" static="false" final="false">
    <docblock>
      <description compact="&#10;      Change the current value of a counter&#10;     "/>
      <return type="void"/>
    </docblock>
    <parameter name="offset" optional="false" byreference="false" type="int"/>
  </method>
  <method name="resetValue" abstract="false" static="false" final="false">
    <docblock>
      <description compact="&#10;      Reset the current value of a counter&#10;     "/>
      <return type="void"/>
    </docblock>
  </method>
  <method name="getMeta" abstract="false" static="false" final="false">
    <docblock>
      <description compact="&#10;      Return a piece of metainformation about a counter&#10;     "/>
      <return type="mixed"/>
    </docblock>
    <parameter name="attribute" optional="false" byreference="false" type="int"/>
  </method>
  <method name="getNamed" abstract="false" static="false" final="false">
    <docblock>
      <description compact="&#10;      Retrieve an existing named counter&#10;     "/>
      <return type="Counter"/>
    </docblock>
    <parameter name="name" optional="false" byreference="false" type="string"/>
  </method>
  <method name="setCounterClass" abstract="false" static="false" final="false">
    <docblock>
      <description compact="&#10;      Set the class returned by Counter::getNamed&#10;     "/>
      <return type="void"/>
    </docblock>
    <parameter name="name" optional="false" byreference="false" type="string"/>
  </method>
</class>