Skip to content
This repository was archived by the owner on Aug 9, 2019. It is now read-only.

Commit 8e81db8

Browse files
committed
Updated documentation
1 parent 1a4d4ca commit 8e81db8

File tree

3 files changed

+7
-7
lines changed

3 files changed

+7
-7
lines changed

lib/HtmlExplorer.php

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ public function __construct($html)
6363
* Finds an element by ID.
6464
*
6565
* @param string $elementId The element ID
66-
* @return \DOMElement|bool
66+
* @return \DOMElement|false
6767
*/
6868
public function find($elementId)
6969
{
@@ -85,7 +85,7 @@ public function findTags($tagName)
8585
* Finds the first element with given tag name.
8686
*
8787
* @param string $tagName The tag name
88-
* @return \DOMNode|bool
88+
* @return \DOMElement|false
8989
*/
9090
public function findFirstTag($tagName)
9191
{
@@ -108,8 +108,8 @@ public function getDOM()
108108
* Loads HTML from webpage.
109109
*
110110
* @param string $url The URL of the webpage
111-
* @param \FlameCore\Webtools\HttpClient $http The HttpClient instance to use (optional)
112-
* @return \FlameCore\Webtools\HtmlExplorer
111+
* @param \FlameCore\Webtools\HttpClient $http The HttpClient instance to use
112+
* @return self
113113
* @throws \RuntimeException if the URL could not be loaded.
114114
*/
115115
public static function fromWeb($url, HttpClient $http = null)
@@ -129,7 +129,7 @@ public static function fromWeb($url, HttpClient $http = null)
129129
* Loads HTML from file.
130130
*
131131
* @param string $filename The name of the file
132-
* @return \FlameCore\Webtools\HtmlExplorer
132+
* @return self
133133
* @throws \LogicException if the file could not be opened.
134134
*/
135135
public static function fromFile($filename)

lib/HttpClient.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -234,7 +234,7 @@ public function setEncoding($encoding)
234234
/**
235235
* Enables the use of cookies.
236236
*
237-
* @param string $jarfile The full path to the file where cookies are saved (optional)
237+
* @param string $jarfile The full path to the file where cookies are saved
238238
* @throws \InvalidArgumentException if the given parameter is invalid.
239239
* @throws \LogicException if the cookie file could not be opened.
240240
*/

lib/WebpageAnalyzer.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -180,7 +180,7 @@ protected function getAbsoluteUrl($href)
180180
* Returns the size of an image.
181181
*
182182
* @param string $url The URL of the image
183-
* @return array|bool Returns an array with width and height of the image or FALSE on error.
183+
* @return array|false Returns an array with width and height of the image or FALSE on error.
184184
*/
185185
protected function getImageSize($url)
186186
{

0 commit comments

Comments
 (0)