Skip to content

Commit c86489a

Browse files
committed
improved jdoc
1 parent 7b3b4e3 commit c86489a

15 files changed

Lines changed: 650 additions & 269 deletions

src/main/java/org/htmlunit/Screen.java

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,8 @@ public Screen(final WebClient webClient) {
4646
}
4747

4848
/**
49+
* Returns the value of the {@code availHeight} property.
50+
*
4951
* @return the {@code availHeight} property
5052
*/
5153
public int getAvailHeight() {
@@ -61,6 +63,8 @@ public void setAvailHeight(final int availHeight) {
6163
}
6264

6365
/**
66+
* Returns the value of the {@code availLeft} property.
67+
*
6468
* @return the {@code availLeft} property
6569
*/
6670
public int getAvailLeft() {
@@ -76,6 +80,8 @@ public void setAvailLeft(final int availLeft) {
7680
}
7781

7882
/**
83+
* Returns the value of the {@code availTop} property.
84+
*
7985
* @return the {@code availTop} property
8086
*/
8187
public int getAvailTop() {
@@ -91,6 +97,8 @@ public void setAvailTop(final int availTop) {
9197
}
9298

9399
/**
100+
* Returns the value of the {@code availWidth} property.
101+
*
94102
* @return the {@code availWidth} property
95103
*/
96104
public int getAvailWidth() {
@@ -106,6 +114,8 @@ public void setAvailWidth(final int availWidth) {
106114
}
107115

108116
/**
117+
* Returns the value of the {@code colorDepth} property.
118+
*
109119
* @return the {@code colorDepth} property
110120
*/
111121
public int getColorDepth() {
@@ -121,6 +131,8 @@ public void setColorDepth(final int colorDepth) {
121131
}
122132

123133
/**
134+
* Returns the value of the {@code deviceXDPI} property.
135+
*
124136
* @return the {@code deviceXDPI} property
125137
*/
126138
public int getDeviceXDPI() {
@@ -136,6 +148,8 @@ public void setDeviceXDPI(final int deviceXDPI) {
136148
}
137149

138150
/**
151+
* Returns the value of the {@code deviceYDPI} property.
152+
*
139153
* @return the {@code deviceYDPI} property
140154
*/
141155
public int getDeviceYDPI() {
@@ -151,6 +165,8 @@ public void setDeviceYDPI(final int deviceYDPI) {
151165
}
152166

153167
/**
168+
* Returns the value of the {@code height} property.
169+
*
154170
* @return the {@code height} property
155171
*/
156172
public int getHeight() {
@@ -166,6 +182,8 @@ public void setHeight(final int height) {
166182
}
167183

168184
/**
185+
* Returns the value of the {@code left} property.
186+
*
169187
* @return the {@code left} property
170188
*/
171189
public int getLeft() {
@@ -181,6 +199,8 @@ public void setLeft(final int left) {
181199
}
182200

183201
/**
202+
* Returns the value of the {@code pixelDepth} property.
203+
*
184204
* @return the {@code pixelDepth} property
185205
*/
186206
public int getPixelDepth() {
@@ -196,6 +216,8 @@ public void setPixelDepth(final int pixelDepth) {
196216
}
197217

198218
/**
219+
* Returns the value of the {@code top} property.
220+
*
199221
* @return the {@code top} property
200222
*/
201223
public int getTop() {
@@ -211,6 +233,8 @@ public void setTop(final int top) {
211233
}
212234

213235
/**
236+
* Returns the value of the {@code width} property.
237+
*
214238
* @return the {@code width} property
215239
*/
216240
public int getWidth() {

src/main/java/org/htmlunit/SgmlPage.java

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -407,14 +407,18 @@ public void clearComputedStylesUpToRoot(final DomElement element) {
407407
}
408408

409409
/**
410-
* @return whether or not this is currently printing
410+
* Returns whether this page is currently being printed.
411+
*
412+
* @return {@code true} if this page is currently being printed
411413
*/
412414
public boolean isPrinting() {
413415
return printing_;
414416
}
415417

416418
/**
417-
* @param printing the printing state to set
419+
* Sets whether this page is currently being printed.
420+
*
421+
* @param printing {@code true} if this page is currently being printed
418422
*/
419423
public void setPrinting(final boolean printing) {
420424
printing_ = printing;
@@ -429,21 +433,26 @@ public void domChangeListenerAdded() {
429433
}
430434

431435
/**
432-
* @return true if at least one domChangeListener was registered.
436+
* Returns whether any DOM change listeners have been registered.
437+
*
438+
* @return {@code true} if at least one DOM change listener has been registered
433439
*/
434440
public boolean isDomChangeListenerInUse() {
435441
return domChangeListenerInUse_;
436442
}
437443

438444
/**
439-
* Informs about the use of a characterDataChangeListener.
445+
* Marks that a character data change listener has been registered.
440446
*/
441447
public void characterDataChangeListenerAdded() {
442448
characterDataChangeListenerInUse_ = true;
443449
}
444450

445451
/**
446-
* @return true if at least one characterDataChangeListener was registered.
452+
* Returns whether any character data change listeners have been registered.
453+
*
454+
* @return {@code true} if at least one character data change listener has
455+
* been registered
447456
*/
448457
public boolean isCharacterDataChangeListenerInUse() {
449458
return characterDataChangeListenerInUse_;

0 commit comments

Comments
 (0)