[aur-dev] [PATCH] aurjson.class.php: Add missing PHPDoc

[Lukas Fleischer]

Signed-off-by: Lukas Fleischer <lfleischer at archlinux.org>
---
 web/lib/aurjson.class.php | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

diff --git a/web/lib/aurjson.class.php b/web/lib/aurjson.class.php
index 4e4d5dc..7d94dab 100644
--- a/web/lib/aurjson.class.php
+++ b/web/lib/aurjson.class.php
@@ -139,6 +139,7 @@ class AurJSON {
 	 * Returns a JSON formatted result data.
 	 *
 	 * @param $type The response method type.
+	 * @param $count The number of results to return
 	 * @param $data The result data to return
 	 * @param $error An error message to include in the response
 	 *
@@ -159,6 +160,13 @@ class AurJSON {
 		return json_encode($json_array);
 	}
 
+	/*
+	 * Get extended package details (for info and multiinfo queries).
+	 *
+	 * @param $pkgid The ID of the package to retrieve details for.
+	 *
+	 * @return array An array containing package details.
+	 */
 	private function get_extended_fields($pkgid) {
 		$query = "SELECT DependencyTypes.Name AS Type, " .
 			"PackageDepends.DepName AS Name, " .
@@ -208,6 +216,15 @@ class AurJSON {
 		return $data;
 	}
 
+	/*
+	 * Retrieve package information (used in info, multiinfo, search and
+	 * msearch requests).
+	 *
+	 * @param $type The request type.
+	 * @param $where_condition An SQL WHERE-condition to filter packages.
+	 *
+	 * @return mixed Returns an array of package matches.
+	 */
 	private function process_query($type, $where_condition) {
 		$max_results = config_get_int('options', 'max_rpc_results');
 
-- 
2.4.6