From 1639f0f1ca301eb0173e06c0471406a122bef9a8 Mon Sep 17 00:00:00 2001
From: Andrew McMillan <debian@mcmillan.net.nz>
Date: Wed, 11 Oct 2006 16:38:53 +1300
Subject: [PATCH] More code cleanups - adding phpdoc header to all caldav
 component parts.

---
 htdocs/caldav.php         |  9 +++++++++
 inc/BasicAuthSession.php  |  2 +-
 inc/caldav-DELETE.php     |  9 +++++++++
 inc/caldav-GET.php        | 10 +++++++++-
 inc/caldav-MKCALENDAR.php | 10 +++++++++-
 inc/caldav-MKCOL.php      | 10 +++++++++-
 inc/caldav-OPTIONS.php    |  9 +++++++++
 inc/caldav-PROPFIND.php   |  9 +++++++++
 inc/caldav-PUT.php        | 10 +++++++++-
 inc/caldav-REPORT.php     | 10 +++++++++-
 rscds.webprj              |  1 -
 11 files changed, 82 insertions(+), 7 deletions(-)

diff --git a/htdocs/caldav.php b/htdocs/caldav.php
index 139ff1b5..873a746b 100644
--- a/htdocs/caldav.php
+++ b/htdocs/caldav.php
@@ -1,4 +1,13 @@
 <?php
+/**
+* CalDAV Server - main program
+*
+* @package   rscds
+* @subpackage   caldav
+* @author    Andrew McMillan <andrew@catalyst.net.nz>
+* @copyright Catalyst .Net Ltd
+* @license   http://gnu.org/copyleft/gpl.html GNU GPL v2
+*/
 require_once("always.php");
 dbg_error_log( "caldav", " User agent: %s", $_SERVER['HTTP_USER_AGENT'] );
 require_once("BasicAuthSession.php");
diff --git a/inc/BasicAuthSession.php b/inc/BasicAuthSession.php
index dd58d007..1b02a1da 100644
--- a/inc/BasicAuthSession.php
+++ b/inc/BasicAuthSession.php
@@ -1,6 +1,6 @@
 <?php
 /**
-* A Class for handling BasicAuthSession data
+* A Class for handling HTTP Basic Authentication
 *
 * @package rscds
 * @subpackage BasicAuthSession
diff --git a/inc/caldav-DELETE.php b/inc/caldav-DELETE.php
index 06ffbde2..c7f381a6 100644
--- a/inc/caldav-DELETE.php
+++ b/inc/caldav-DELETE.php
@@ -1,4 +1,13 @@
 <?php
+/**
+* CalDAV Server - handle DELETE method
+*
+* @package   rscds
+* @subpackage   caldav
+* @author    Andrew McMillan <andrew@catalyst.net.nz>
+* @copyright Catalyst .Net Ltd
+* @license   http://gnu.org/copyleft/gpl.html GNU GPL v2
+*/
 dbg_error_log("delete", "DELETE method handler");
 
 /**
diff --git a/inc/caldav-GET.php b/inc/caldav-GET.php
index 521ebfc8..3b40757e 100644
--- a/inc/caldav-GET.php
+++ b/inc/caldav-GET.php
@@ -1,5 +1,13 @@
 <?php
-
+/**
+* CalDAV Server - handle GET method
+*
+* @package   rscds
+* @subpackage   caldav
+* @author    Andrew McMillan <andrew@catalyst.net.nz>
+* @copyright Catalyst .Net Ltd
+* @license   http://gnu.org/copyleft/gpl.html GNU GPL v2
+*/
 dbg_error_log("get", "GET method handler");
 
 // The GET method is not sent with any wrapping XML so we simply fetch it
diff --git a/inc/caldav-MKCALENDAR.php b/inc/caldav-MKCALENDAR.php
index 7382aa84..eccb27b1 100644
--- a/inc/caldav-MKCALENDAR.php
+++ b/inc/caldav-MKCALENDAR.php
@@ -1,5 +1,13 @@
 <?php
-
+/**
+* CalDAV Server - handle MKCALENDAR method
+*
+* @package   rscds
+* @subpackage   caldav
+* @author    Andrew McMillan <andrew@catalyst.net.nz>
+* @copyright Catalyst .Net Ltd
+* @license   http://gnu.org/copyleft/gpl.html GNU GPL v2
+*/
 dbg_error_log("MKCALENDAR", "method handler");
 
 dbg_log_array( "MKCOL", 'HEADERS', $raw_headers );
diff --git a/inc/caldav-MKCOL.php b/inc/caldav-MKCOL.php
index db2c6e38..3e76399a 100644
--- a/inc/caldav-MKCOL.php
+++ b/inc/caldav-MKCOL.php
@@ -1,5 +1,13 @@
 <?php
-
+/**
+* CalDAV Server - handle MKCOL method
+*
+* @package   rscds
+* @subpackage   caldav
+* @author    Andrew McMillan <andrew@catalyst.net.nz>
+* @copyright Catalyst .Net Ltd
+* @license   http://gnu.org/copyleft/gpl.html GNU GPL v2
+*/
 dbg_error_log("MKCOL", "method handler");
 
 dbg_log_array( "MKCOL", 'HEADERS', $raw_headers );
diff --git a/inc/caldav-OPTIONS.php b/inc/caldav-OPTIONS.php
index c35992e9..4ffad1df 100644
--- a/inc/caldav-OPTIONS.php
+++ b/inc/caldav-OPTIONS.php
@@ -1,4 +1,13 @@
 <?php
+/**
+* CalDAV Server - handle OPTIONS method
+*
+* @package   rscds
+* @subpackage   caldav
+* @author    Andrew McMillan <andrew@catalyst.net.nz>
+* @copyright Catalyst .Net Ltd
+* @license   http://gnu.org/copyleft/gpl.html GNU GPL v2
+*/
   dbg_error_log("OPTIONS", "method handler");
 
   header( "Content-type: text/plain" );
diff --git a/inc/caldav-PROPFIND.php b/inc/caldav-PROPFIND.php
index 01c942ec..92dfb70a 100644
--- a/inc/caldav-PROPFIND.php
+++ b/inc/caldav-PROPFIND.php
@@ -1,4 +1,13 @@
 <?php
+/**
+* CalDAV Server - handle PROPFIND method
+*
+* @package   rscds
+* @subpackage   caldav
+* @author    Andrew McMillan <andrew@catalyst.net.nz>
+* @copyright Catalyst .Net Ltd
+* @license   http://gnu.org/copyleft/gpl.html GNU GPL v2
+*/
 dbg_error_log("PROPFIND", "method handler");
 
 require_once("XMLElement.php");
diff --git a/inc/caldav-PUT.php b/inc/caldav-PUT.php
index eac8c57b..31930596 100644
--- a/inc/caldav-PUT.php
+++ b/inc/caldav-PUT.php
@@ -1,5 +1,13 @@
 <?php
-
+/**
+* CalDAV Server - handle PUT method
+*
+* @package   rscds
+* @subpackage   caldav
+* @author    Andrew McMillan <andrew@catalyst.net.nz>
+* @copyright Catalyst .Net Ltd
+* @license   http://gnu.org/copyleft/gpl.html GNU GPL v2
+*/
 dbg_error_log("PUT", "method handler");
 
 // The PUT method is not sent with any wrapping XML so we simply store it
diff --git a/inc/caldav-REPORT.php b/inc/caldav-REPORT.php
index 378de6a6..19c51953 100644
--- a/inc/caldav-REPORT.php
+++ b/inc/caldav-REPORT.php
@@ -1,5 +1,13 @@
 <?php
-
+/**
+* CalDAV Server - handle REPORT method
+*
+* @package   rscds
+* @subpackage   caldav
+* @author    Andrew McMillan <andrew@catalyst.net.nz>
+* @copyright Catalyst .Net Ltd
+* @license   http://gnu.org/copyleft/gpl.html GNU GPL v2
+*/
 dbg_error_log("REPORT", "method handler");
 
 require_once("XMLElement.php");
diff --git a/rscds.webprj b/rscds.webprj
index 0797641a..35f54d3b 100644
--- a/rscds.webprj
+++ b/rscds.webprj
@@ -23,7 +23,6 @@
     <item url="inc/caldav-DELETE.php" uploadstatus="1" />
     <item url="htdocs/caldav.php" uploadstatus="1" />
     <item url="inc/BasicAuthSession.php" uploadstatus="1" />
-    <item url="inc/session-util.php" uploadstatus="1" />
     <item url="debian/" uploadstatus="1" />
     <item url="debian/rules" uploadstatus="1" />
     <item url="dba/rscds.sql" uploadstatus="1" />