From 30f4d91d01cc9f0f32767a466a5024ad4f76ebf5 Mon Sep 17 00:00:00 2001
From: Morris Jobke <morris.jobke@gmail.com>
Date: Thu, 17 Oct 2013 00:07:29 +0200
Subject: Public API documentation fixes

refs #4883

 * http/response.php
 * config.php
 * response.php
 * files.php
 * idbconnection.php
 * app.php
 * user.php
 * template.php
 * share.php
 * db.php
 * icache.php & il10n.php
---
 lib/public/appframework/http/response.php | 14 ++++++++++++--
 1 file changed, 12 insertions(+), 2 deletions(-)

(limited to 'lib/public/appframework')

diff --git a/lib/public/appframework/http/response.php b/lib/public/appframework/http/response.php
index 64477258948..5ca389b9946 100644
--- a/lib/public/appframework/http/response.php
+++ b/lib/public/appframework/http/response.php
@@ -26,12 +26,15 @@ namespace OCP\AppFramework\Http;
 
 
 /**
- * Base class for responses. Also used to just send headers
+ * Base class for responses. Also used to just send headers.
+ *
+ * It handles headers, HTTP status code, last modified and ETag.
  */
 class Response {
 
 	/**
-	 * @var array default headers
+	 * Headers - defaults to ['Cache-Control' => 'no-cache, must-revalidate']
+	 * @var array
 	 */
 	private $headers = array(
 		'Cache-Control' => 'no-cache, must-revalidate'
@@ -39,18 +42,21 @@ class Response {
 
 
 	/**
+	 * HTTP status code - defaults to STATUS OK
 	 * @var string
 	 */
 	private $status = Http::STATUS_OK;
 
 
 	/**
+	 * Last modified date
 	 * @var \DateTime
 	 */
 	private $lastModified;
 
 
 	/**
+	 * ETag
 	 * @var string
 	 */
 	private $ETag;
@@ -135,6 +141,7 @@ class Response {
 
 
 	/**
+	 * Get the ETag
 	 * @return string the etag
 	 */
 	public function getETag() {
@@ -143,6 +150,7 @@ class Response {
 
 
 	/**
+	 * Get "last modified" date
 	 * @return string RFC2822 formatted last modified date
 	 */
 	public function getLastModified() {
@@ -151,6 +159,7 @@ class Response {
 
 
 	/**
+	 * Set the ETag
 	 * @param string $ETag
 	 */
 	public function setETag($ETag) {
@@ -159,6 +168,7 @@ class Response {
 
 
 	/**
+	 * Set "last modified" date
 	 * @param \DateTime $lastModified
 	 */
 	public function setLastModified($lastModified) {
-- 
cgit v1.2.3