File: tidy.xml

package info (click to toggle)
phpdox 0.11.2-1
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 6,476 kB
  • sloc: xml: 66,377; php: 9,049; makefile: 18
file content (144 lines) | stat: -rw-r--r-- 7,209 bytes parent folder | download 
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
140
141
142
143
144
 
<?xml version="1.0" encoding="UTF-8" ?>
<class xmlns="http://xml.phpdox.net/src" full="tidy" namespace="" name="tidy">
  <member name="tidy-&gt;errorBuffer" static="false">
    <default>null</default>
    <docblock>
      <description compact="Object oriented style (property):">Object oriented style (property):</description>
      <var type="string"/>
    </docblock>
  </member>
  <method name="body" abstract="false" static="false" final="false">
    <docblock>
      <description compact="Returns a tidyNode object starting from the &lt;body&gt; tag of the tidy parse tree">Object oriented style</description>
      <return type="tidyNode"/>
    </docblock>
  </method>
  <method name="cleanRepair" abstract="false" static="false" final="false">
    <docblock>
      <description compact="Execute configured cleanup and repair operations on parsed markup">Object oriented style</description>
      <return type="bool"/>
    </docblock>
  </method>
  <constructor name="__construct" abstract="false" static="false" final="false">
    <docblock>
      <description compact="Constructs a new tidy object"/>
      <return type="void"/>
    </docblock>
    <parameter name="filename" optional="true" byreference="false" type="string"/>
    <parameter name="config" optional="true" byreference="false" type="object" class="mixed"/>
    <parameter name="encoding" optional="true" byreference="false" type="string"/>
    <parameter name="use_include_path" optional="true" byreference="false" type="object" class="bool"/>
  </constructor>
  <method name="diagnose" abstract="false" static="false" final="false">
    <docblock>
      <description compact="Run configured diagnostics on parsed and repaired markup">Object oriented style</description>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="getConfig" abstract="false" static="false" final="false">
    <docblock>
      <description compact="Get current Tidy configuration">Object oriented style</description>
      <return type="array"/>
    </docblock>
  </method>
  <method name="getHtmlVer" abstract="false" static="false" final="false">
    <docblock>
      <description compact="Get the Detected HTML version for the specified document">Object oriented style</description>
      <return type="int"/>
    </docblock>
  </method>
  <method name="getOpt" abstract="false" static="false" final="false">
    <docblock>
      <description compact="Returns the value of the specified configuration option for the tidy document">Object oriented style</description>
      <return type="mixed"/>
    </docblock>
    <parameter name="option" optional="false" byreference="false" type="string"/>
  </method>
  <method name="getOptDoc" abstract="false" static="false" final="false">
    <docblock>
      <description compact="&#10;   Returns the documentation for the given option name&#10;  ">Object oriented style</description>
      <return type="string"/>
    </docblock>
    <parameter name="optname" optional="false" byreference="false" type="string"/>
  </method>
  <method name="getRelease" abstract="false" static="false" final="false">
    <docblock>
      <description compact="Get release date (version) for Tidy library">Object oriented style</description>
      <return type="string"/>
    </docblock>
  </method>
  <method name="getStatus" abstract="false" static="false" final="false">
    <docblock>
      <description compact="Get status of specified document">Object oriented style</description>
      <return type="int"/>
    </docblock>
  </method>
  <method name="head" abstract="false" static="false" final="false">
    <docblock>
      <description compact="Returns a tidyNode object starting from the &lt;head&gt; tag of the tidy parse tree">Object oriented style</description>
      <return type="tidyNode"/>
    </docblock>
  </method>
  <method name="html" abstract="false" static="false" final="false">
    <docblock>
      <description compact="Returns a tidyNode object starting from the &lt;html&gt; tag of the tidy parse tree">Object oriented style</description>
      <return type="tidyNode"/>
    </docblock>
  </method>
  <method name="isXhtml" abstract="false" static="false" final="false">
    <docblock>
      <description compact="Indicates if the document is a XHTML document">Object oriented style</description>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="isXml" abstract="false" static="false" final="false">
    <docblock>
      <description compact="Indicates if the document is a generic (non HTML/XHTML) XML document">Object oriented style</description>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="parseFile" abstract="false" static="false" final="false">
    <docblock>
      <description compact="Parse markup in file or URI">Object oriented style</description>
      <return type="bool"/>
    </docblock>
    <parameter name="filename" optional="false" byreference="false" type="string"/>
    <parameter name="config" optional="true" byreference="false" type="object" class="mixed"/>
    <parameter name="encoding" optional="true" byreference="false" type="string"/>
    <parameter name="use_include_path" optional="true" byreference="false" type="object" class="bool"/>
  </method>
  <method name="parseString" abstract="false" static="false" final="false">
    <docblock>
      <description compact="Parse a document stored in a string">Object oriented style</description>
      <return type="bool"/>
    </docblock>
    <parameter name="input" optional="false" byreference="false" type="string"/>
    <parameter name="config" optional="true" byreference="false" type="object" class="mixed"/>
    <parameter name="encoding" optional="true" byreference="false" type="string"/>
  </method>
  <method name="repairFile" abstract="false" static="false" final="false">
    <docblock>
      <description compact="Repair a file and return it as a string">Object oriented style</description>
      <return type="string"/>
    </docblock>
    <parameter name="filename" optional="false" byreference="false" type="string"/>
    <parameter name="config" optional="true" byreference="false" type="object" class="mixed"/>
    <parameter name="encoding" optional="true" byreference="false" type="string"/>
    <parameter name="use_include_path" optional="true" byreference="false" type="object" class="bool"/>
  </method>
  <method name="repairString" abstract="false" static="false" final="false">
    <docblock>
      <description compact="Repair a string using an optionally provided configuration file">Object oriented style</description>
      <return type="string"/>
    </docblock>
    <parameter name="data" optional="false" byreference="false" type="string"/>
    <parameter name="config" optional="true" byreference="false" type="object" class="mixed"/>
    <parameter name="encoding" optional="true" byreference="false" type="string"/>
  </method>
  <method name="root" abstract="false" static="false" final="false">
    <docblock>
      <description compact="Returns a tidyNode object representing the root of the tidy parse tree">Object oriented style</description>
      <return type="tidyNode"/>
    </docblock>
  </method>
</class>