Menu
▾
▴
[HtmlUnit] CVS Commit: htmlunit: Removed <javadoc> tags from documentation.
|
From: <no...@us...> - 2003-07-19 19:25:48
|
Log Message:
-----------
Removed <javadoc> tags from documentation. These were leftovers from the old build system and aren't used by maven.
Modified Files:
--------------
/cvsroot/htmlunit/htmlunit/src/xdocs:
window-howto.xml
keyboard-howto.xml
Revision Data
-------------
Index: window-howto.xml
===================================================================
RCS file: /cvsroot/htmlunit/htmlunit/src/xdocs/window-howto.xml,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -d -r1.7 -r1.8
--- window-howto.xml 11 Apr 2003 19:29:18 -0000 1.7
+++ window-howto.xml 19 Jul 2003 19:25:47 -0000 1.8
@@ -10,20 +10,15 @@
<body>
<section>
<p>
- All pages are contained within
- <javadoc>com.gargoylesoftware.htmlunit.WebWindow</javadoc> objects. This could be a
- <javadoc>com.gargoylesoftware.htmlunit.TopLevelWindow</javadoc> representing an actual
- browser window, an
- <javadoc>com.gargoylesoftware.htmlunit.html.HtmlFrame</javadoc> representing a <frame>
- element or an
- <javadoc>com.gargoylesoftware.htmlunit.html.HtmlInlineFrame</javadoc> representing an
- <iframe> element.
+ All pages are contained within WebWindow objects. This could be a
+ TopLevelWindow representing an actual browser window, an
+ HtmlFrame representing a <frame> element or an
+ HtmlInlineFrame representing an <iframe> element.
</p>
<p>
- When a <javadoc>com.gargoylesoftware.htmlunit.WebClient</javadoc> is first instantiated,
- a <javadoc>com.gargoylesoftware.htmlunit.TopLevelWindow</javadoc> is automatically created.
+ When a WebClient is first instantiated, a TopLevelWindow is automatically created.
You could think of this as being the first window displayed by a web browser. Calling
- <javadoc>com.gargoylesoftware.htmlunit.WebClient#getPage(com.gargoylesoftware.htmlunit.WebWindow, java.net.URL, com.gargoylesoftware.htmlunit.SubmitMethod, java.util.List, boolean)</javadoc>
+ WebClient.getPage(WebWindow, URL, SubmitMethod, List, boolean)
will load the new page into this window.
</p>
<p>
@@ -36,21 +31,20 @@
<section name="WebWindowEvents">
<p>
If you wish to be notified when windows are created or pages are loaded, you need to register a
- <javadoc>com.gargoylesoftware.htmlunit.WebWindowListener</javadoc> with the WebClient via the
- method <javadoc>com.gargoylesoftware.htmlunit.WebClient#addWebWindowListener(com.gargoylesoftware.htmlunit.WebWindowListener)</javadoc>
+ WebWindowListener with the WebClient via the
+ method WebClient.addWebWindowListener(WebWindowListener)
</p>
<p>
When a window is opened either by javascript or through the WebClient, a WebWindowEvent will be
fired and passed into the
- <javadoc>com.gargoylesoftware.htmlunit.WebWindowListener#webWindowOpened(com.gargoylesoftware.htmlunit.WebWindowEvent)</javadoc>
+ WebWindowListener.webWindowOpened(WebWindowEvent)
method. Note that both the new and old pages in the event will be null as the window does not
have any content loaded at this point. If a url was specified during creation of the window then the page
will be loaded and another event will be fired as described below.
</p>
<p>
When a new page is loaded into a specific window, a WebWindowEvent will be fired and passed into the
- <javadoc>com.gargoylesoftware.htmlunit.WebWindowListener#webWindowContentChanged(com.gargoylesoftware.htmlunit.WebWindowEvent)</javadoc>
- method.
+ WebWindowListener.webWindowContentChanged(WebWindowEvent) method.
</p>
</section>
</body>
Index: keyboard-howto.xml
===================================================================
RCS file: /cvsroot/htmlunit/htmlunit/src/xdocs/keyboard-howto.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -d -r1.4 -r1.5
--- keyboard-howto.xml 11 Apr 2003 19:29:17 -0000 1.4
+++ keyboard-howto.xml 19 Jul 2003 19:25:47 -0000 1.5
@@ -15,36 +15,34 @@
</p>
<p>
There are several ways to move the focus from one element to another. The simplest is to call
- <javadoc>com.gargoylesoftware.htmlunit.WebClient#moveFocusToElement(com.gargoylesoftware.htmlunit.html.HtmlElement)</javadoc>.
+ WebClient.moveFocusToElement(HtmlElement).
This method will remove focus from whatever element currently has it, if any, and will set
it to the new component. Along the way, it will fire off any "onfocus" and "onblur" handlers
that have been defined.
</p>
<p>
The element currently owning the focus can be determined with a call to
- <javadoc>com.gargoylesoftware.htmlunit.WebClient#getElementWithFocus()</javadoc>
+ WebClient.getElementWithFocus().
</p>
<p>
To simulate keyboard navigation via the tab key, you can call
- <javadoc>com.gargoylesoftware.htmlunit.html.HtmlPage#tabToNextElement()</javadoc>
- and
- <javadoc>com.gargoylesoftware.htmlunit.html.HtmlPage#tabToPreviousElement()</javadoc>
+ HtmlPage.tabToNextElement() and HtmlPage.tabToPreviousElement()
to cycle forward or backwards through the defined tab order. This tab order is
defined by the
<a href="http://www.w3.org/TR/html401/interact/forms.html#adef-tabindex">tabindex</a>
attribute on the various elements as defined by the HTML specification. You can query
the defined tab order with the method
- <javadoc>com.gargoylesoftware.htmlunit.html.HtmlPage.getTabbableElements()</javadoc>
+ HtmlPage.getTabbableElements()
which will return a list of all tabbable elements in defined tab order.
</p>
<p>
Access keys, often called keyboard mnemonics, can be simulated with the method
- <javadoc>com.gargoylesoftware.htmlunit.html.HtmlPage#pressAccessKey(char)</javadoc>.
+ HtmlPage.pressAccessKey(char).
</p>
<p>
Finally, there is an assertion for testing that will verify that every tabbable element
has a defined tabindex attribute. This is done with
- <javadoc>com.gargoylesoftware.htmlunit.html.HtmlPage#assertAllTabIndexAttributesSet()</javadoc>.
+ HtmlPage.assertAllTabIndexAttributesSet().
</p>
</section>
</body>
|
