Fix #6913 - add more documentation to code
[roojs1] / docs / symbols / Roo.lib.Dom.json
1 {
2   "name" : "Roo.lib.Dom",
3   "augments" : [],
4   "childClasses" : {  },
5   "tree_children" : [],
6   "tree_parent" : [],
7   "desc" : "Dom utils (from YIU afaik)",
8   "isSingleton" : false,
9   "isStatic" : true,
10   "isBuiltin" : false,
11   "isAbstract" : false,
12   "isBuilderTop" : false,
13   "memberOf" : "Dom",
14   "example" : "",
15   "deprecated" : "",
16   "since" : "",
17   "see" : "",
18   "params" : [],
19   "returns" : [],
20   "throws" : "",
21   "requires" : "",
22   "config" : [],
23   "methods" : [
24     {
25       "name" : "getDocumentWidth",
26       "type" : "function",
27       "desc" : "Get the Full Document width",
28       "sig" : "()\n{\n\n}",
29       "static" : true,
30       "memberOf" : "",
31       "isStatic" : true,
32       "isConstructor" : false,
33       "isPrivate" : false,
34       "example" : "",
35       "deprecated" : "",
36       "since" : "",
37       "see" : "",
38       "exceptions" : "",
39       "requires" : "",
40       "params" : [],
41       "returns" : [
42         {
43           "name" : "",
44           "type" : "Number",
45           "desc" : "The width"
46         }
47       ]
48     },
49     {
50       "name" : "getViewportWidth",
51       "type" : "function",
52       "desc" : "Get the Window Viewport width",
53       "sig" : "()\n{\n\n}",
54       "static" : true,
55       "memberOf" : "",
56       "isStatic" : true,
57       "isConstructor" : false,
58       "isPrivate" : false,
59       "example" : "",
60       "deprecated" : "",
61       "since" : "",
62       "see" : "",
63       "exceptions" : "",
64       "requires" : "",
65       "params" : [],
66       "returns" : [
67         {
68           "name" : "",
69           "type" : "Number",
70           "desc" : "The width"
71         }
72       ]
73     },
74     {
75       "name" : "getViewWidth",
76       "type" : "function",
77       "desc" : "Get the view width",
78       "sig" : "(full)",
79       "static" : true,
80       "memberOf" : "",
81       "isStatic" : true,
82       "isConstructor" : false,
83       "isPrivate" : false,
84       "example" : "",
85       "deprecated" : "",
86       "since" : "",
87       "see" : "",
88       "exceptions" : "",
89       "requires" : "",
90       "params" : [
91         {
92           "name" : "full",
93           "type" : "Boolean",
94           "desc" : "True will get the full document, otherwise it's the view width",
95           "isOptional" : false
96         }
97       ],
98       "returns" : [
99         {
100           "name" : "",
101           "type" : "Number",
102           "desc" : "The width"
103         }
104       ]
105     },
106     {
107       "name" : "getDocumentHeight",
108       "type" : "function",
109       "desc" : "Get the Full Document height",
110       "sig" : "()\n{\n\n}",
111       "static" : true,
112       "memberOf" : "",
113       "isStatic" : true,
114       "isConstructor" : false,
115       "isPrivate" : false,
116       "example" : "",
117       "deprecated" : "",
118       "since" : "",
119       "see" : "",
120       "exceptions" : "",
121       "requires" : "",
122       "params" : [],
123       "returns" : [
124         {
125           "name" : "",
126           "type" : "Number",
127           "desc" : "The height"
128         }
129       ]
130     },
131     {
132       "name" : "getViewHeight",
133       "type" : "function",
134       "desc" : "Get the view height",
135       "sig" : "(full)",
136       "static" : true,
137       "memberOf" : "",
138       "isStatic" : true,
139       "isConstructor" : false,
140       "isPrivate" : false,
141       "example" : "",
142       "deprecated" : "",
143       "since" : "",
144       "see" : "",
145       "exceptions" : "",
146       "requires" : "",
147       "params" : [
148         {
149           "name" : "full",
150           "type" : "Boolean",
151           "desc" : "True will get the full document, otherwise it's the view height",
152           "isOptional" : false
153         }
154       ],
155       "returns" : [
156         {
157           "name" : "",
158           "type" : "Number",
159           "desc" : "The height"
160         }
161       ]
162     },
163     {
164       "name" : "getViewportHeight",
165       "type" : "function",
166       "desc" : "Get the Window Viewport height",
167       "sig" : "()\n{\n\n}",
168       "static" : true,
169       "memberOf" : "",
170       "isStatic" : true,
171       "isConstructor" : false,
172       "isPrivate" : false,
173       "example" : "",
174       "deprecated" : "",
175       "since" : "",
176       "see" : "",
177       "exceptions" : "",
178       "requires" : "",
179       "params" : [],
180       "returns" : [
181         {
182           "name" : "",
183           "type" : "Number",
184           "desc" : "The height"
185         }
186       ]
187     }
188   ],
189   "events" : []
190 }