Trying to get documentation to "Do The Right Thing" (TM)

lib/public/json.php

@@ -35,17 +35,16 @@ namespace OCP;
  */
 class JSON {
 
-
 	/**
 	* @brief Encode and print $data in JSON format
 	* @param array $data The data to use
 	* @param string $setContentType the optional content type
+	* @return string json formatted string.
 	*/
 	public static function encodedPrint( $data, $setContentType=true ){
 		return(\OC_JSON::encodedPrint( $data, $setContentType ));
 	}
 
-
 	/**
 	* Check if the user is logged in, send json error msg if not.
 	* 
@@ -59,7 +58,7 @@ class JSON {
 	* Add this call to the start of all ajax method files that requires
 	* an authenticated user.
 	* 
-	 * @return json Error msg if not valid.
+	* @return string json formatted error string if not authenticated.
 	*/
 	public static function checkLoggedIn(){
 		return(\OC_JSON::checkLoggedIn());
@@ -83,21 +82,25 @@ class JSON {
 	* parameter to the ajax call, then assign it to the template and finally
 	* add a hidden input field also named 'requesttoken' containing the value.
 	* 
-	 * @return json Error msg if not valid.
+	* @return string json formatted error string if not valid.
 	*/
 	public static function callCheck(){
 		return(\OC_JSON::callCheck());
 	}
 
 	/**
-	* @brief Send json success msg
+	* Send json success msg
+	* 
+	* Return a json success message with optional extra data.
+	* @see OCP\JSON::error() 		for the format to use.
+	* 
 	* @param array $data The data to use
+	* @return string json formatted string.
 	*/
 	public static function success( $data = array() ){
 		return(\OC_JSON::success( $data ));
 	}
 
-
 	/**
 	* Send json error msg
 	* 
@@ -114,22 +117,21 @@ class JSON {
 	*     {"status":"error","data":{"message":"An error happened", "id":[some value]}}
 	* 
 	* @param array $data The data to use
-	* @return json formatted error string.
+	* @return string json formatted error string.
 	*/
 	public static function error( $data = array() ){
 		return(\OC_JSON::error( $data ));
 	}
 
-
 	/**
 	* @brief set Content-Type header to jsonrequest
 	* @param array $type The contwnt type header
+	* @return string json formatted string.
 	*/
 	public static function setContentTypeHeader( $type='application/json' ){
 		return(\OC_JSON::setContentTypeHeader( $type ));
 	}
 
-
 	/**
 	* Check if the App is enabled and send JSON error message instead
 	* 
@@ -144,12 +146,12 @@ class JSON {
 	* a specific app to be enabled.
 	* 
 	* @param string $app The app to check
+	* @return string json formatted string if not enabled.
 	*/
 	public static function checkAppEnabled( $app ){
 		return(\OC_JSON::checkAppEnabled( $app ));
 	}
 
-
 	/**
 	* Check if the user is a admin, send json error msg if not
 	* 
@@ -163,6 +165,7 @@ class JSON {
 	* Add this call to the start of all ajax method files that requires
 	* administrative rights.
 	* 
+	* @return string json formatted string if not admin user.
 	*/
 	public static function checkAdminUser(){
 		return(\OC_JSON::checkAdminUser());