add description for documentation

zhanghongyi · zhanghongyi · commit 6562a8a88ca5 · 2015-12-09T12:46:49.000-08:00
Signed-off-by: Hongyi Zhang &lt;hongyi73.zhang@gmail.com&gt;
diff --git a/system/helpers/path_helper.php b/system/helpers/path_helper.php
@@ -57,7 +57,7 @@
 	 * @param	string
 	 * @param	bool	checks to see if the path exists
 	 * @return	string
-	 * @throws	InvalidArgumentException
+	 * @throws	InvalidArgumentException	When the input path is invalid
 	 */
 	function set_realpath($path, $check_existance = FALSE)
 	{
diff --git a/user_guide_src/source/helpers/path_helper.rst b/user_guide_src/source/helpers/path_helper.rst
@@ -31,7 +31,7 @@ The following functions are available:
 	:param	bool	$check_existance: Whether to check if the path actually exists
 	:returns:	An absolute path
 	:rtype:	string
-	:throws: InvalidArgumentException
+	:throws:	InvalidArgumentException	When the input path is invalid
 
 	This function will return a server path without symbolic links or
 	relative directory structures. An optional second argument will

Original file line number	Diff line number	Diff line change
`@@ -57,7 +57,7 @@`
`57`	`57`	`* @param string`
`58`	`58`	`* @param bool checks to see if the path exists`
`59`	`59`	`* @return string`
`60`		`- * @throws InvalidArgumentException`
	`60`	`+ * @throws InvalidArgumentException When the input path is invalid`
`61`	`61`	`*/`
`62`	`62`	`function set_realpath($path, $check_existance = FALSE)`
`63`	`63`	`{`