Update function comments

Ethan Jinks O'Sullivan · Ethan Jinks O'Sullivan · commit fc50bf6cafe5 · 2020-10-26T14:41:49.000-04:00
diff --git a/index.php b/index.php
@@ -69,6 +69,12 @@
     return;
 }
 
+/**
+ * @param string $xml XML code to convert to JSON
+ * @param array $options Options of the API to change JSON output
+ *
+ * @return array The JSON response
+ */
 function xmlToArray($xml, $options = [])
 {
     $defaults = [
@@ -161,7 +167,7 @@ function xmlToArray($xml, $options = [])
  * @param string $title Title of the error, (eg "Missing Parameter") when `$_GET['xml']` doesn't exist
  * @param string $detail Description for the title
  *
- * @return array The response
+ * @return array The error response
  */
 function constructErrorResponse($statusCode, $title, $detail)
 {

Original file line number	Diff line number	Diff line change
`@@ -69,6 +69,12 @@`
`69`	`69`	`return;`
`70`	`70`	`}`
`71`	`71`
	`72`	`+/**`
	`73`	`+ * @param string $xml XML code to convert to JSON`
	`74`	`+ * @param array $options Options of the API to change JSON output`
	`75`	`+ *`
	`76`	`+ * @return array The JSON response`
	`77`	`+ */`
`72`	`78`	`function xmlToArray($xml, $options = [])`
`73`	`79`	`{`
`74`	`80`	`$defaults = [`
`@@ -161,7 +167,7 @@ function xmlToArray($xml, $options = [])`
`161`	`167`	* @param string $title Title of the error, (eg "Missing Parameter") when `$_GET['xml']` doesn't exist
`162`	`168`	`* @param string $detail Description for the title`
`163`	`169`	`*`
`164`		`- * @return array The response`
	`170`	`+ * @return array The error response`
`165`	`171`	`*/`
`166`	`172`	`function constructErrorResponse($statusCode, $title, $detail)`
`167`	`173`	`{`