Added comments describing reason for each file

calendar/libxpical/oeDateTimeImpl.cpp

@@ -35,6 +35,10 @@
  * 
 */
 
+/* This file implements a date-time XPCOM object used to pass date-time values between the frontend and the
+backend. It provides access to individual date-time fields from javascript and translates that data to a 
+icaltimetype structure for the backend.*/
+
 #ifndef WIN32
 #include <unistd.h>
 #endif

calendar/libxpical/oeDateTimeImpl.h

@@ -35,6 +35,8 @@
  * 
 */
 
+/* Header file for oeDateTimeImpl.cpp containing its CID and CONTRACTID.*/
+
 #ifndef __OE_DATETIMEIMPL_H__
 #define __OE_DATETIMEIMPL_H__
 

calendar/libxpical/oeICalContainerImpl.cpp

@@ -34,6 +34,11 @@
  *
  * ***** END LICENSE BLOCK ***** */
 
+/* This file implements the Container object for calendars. The container is the topmost object in 
+the backend and contains and interact with all calendar objects. It acts as a distributor of global
+commands to individual calendars and a collector of calculated data for global queries.
+*/
+
 #include "oeICalContainerImpl.h"
 #include "nsISupportsArray.h"
 #include "nsComponentManagerUtils.h"

calendar/libxpical/oeICalContainerImpl.h

@@ -34,6 +34,8 @@
  *
  * ***** END LICENSE BLOCK ***** */
 
+/* Header file for oeICalContainerImpl.cpp containing its CID and CONTRACTID.*/
+
 #include "oeIICal.h"
 #include "oeICalImpl.h"
 #include "oeICalEventImpl.h"

calendar/libxpical/oeICalEventImpl.cpp

@@ -36,6 +36,11 @@
  *
  * ***** END LICENSE BLOCK ***** */
 
+/* This file implements an XPCOM object which represents a calendar event. It provides access to individual 
+fields of an event and performs calculations concerning its behaviour. The code for the eventDisplay object
+which is an event with display information added to it is included here as well.
+*/
+
 #include <stdlib.h> // for atol
 
 #include "oeICalEventImpl.h"

calendar/libxpical/oeICalEventImpl.h

@@ -34,6 +34,9 @@
  * the terms of any one of the MPL, the GPL or the LGPL.
  *
  * ***** END LICENSE BLOCK ***** */
+ 
+ /* Header file for oeICalEventImpl.cpp containing its CID and CONTRACTID.*/
+
 #ifndef _OEICALEVENTIMPL_H_
 #define _OEICALEVENTIMPL_H_
 

calendar/libxpical/oeICalFactory.cpp

@@ -34,6 +34,8 @@
  *
  * ***** END LICENSE BLOCK ***** */
 
+/* Factory implementation of various calendar objects */
+
 #include "oeICalImpl.h"
 #include "oeICalContainerImpl.h"
 #include "oeICalEventImpl.h"

calendar/libxpical/oeICalImpl.cpp

@@ -33,6 +33,10 @@
  * the terms of any one of the MPL, the GPL or the LGPL.
  *
  * ***** END LICENSE BLOCK ***** */
+ 
+ /* This file implements an XPCOM object which represents a calendar object. It is a container
+ of events and prepares responses for queries made upon the calendar in whole. The task of reading from
+ and writing to the calendar data storage is currently performed by this object */
 
 #ifndef WIN32
 #include <unistd.h>

calendar/libxpical/oeICalImpl.h

@@ -33,6 +33,10 @@
  * the terms of any one of the MPL, the GPL or the LGPL.
  *
  * ***** END LICENSE BLOCK ***** */
+ 
+ /* Header file for oeICalImpl.cpp containing its CID and CONTRACTID. It also includes
+ the implementation for an event linked-list used throughout the code */
+ 
 #ifndef _OEICALIMPL_H_
 #define _OEICALIMPL_H_
 

calendar/libxpical/oeICalStartupHandler.cpp

@@ -35,6 +35,9 @@
  *
  * ***** END LICENSE BLOCK ***** */
 
+/* Derived from nsICmdLineHandler this file provides the "-calendar" option 
+for launching calendar */
+
 #include "plstr.h"
 #include "nsString.h"
 #include "oeICalStartupHandler.h"

calendar/libxpical/oeICalStartupHandler.h

@@ -35,6 +35,8 @@
  *
  * ***** END LICENSE BLOCK ***** */
 
+/* Header file for oeICalStartupHandler.cpp containing its CID and CONTRACTID.*/
+
 #ifndef __oeICalStartupHandler_h_
 #define __oeICalStartupHandler_h_
 

calendar/libxpical/oeICalTodoImpl.cpp

@@ -35,6 +35,10 @@
  *
  * ***** END LICENSE BLOCK ***** */
 
+/* This file implements an XPCOM object which represents a calendar task(todo) object. It is a derivation
+of the event object which adds fields exclusive to tasks.
+*/
+
 #ifndef WIN32
 #include <unistd.h>
 #endif

calendar/libxpical/oeICalTodoImpl.h

@@ -34,6 +34,9 @@
  * the terms of any one of the MPL, the GPL or the LGPL.
  *
  * ***** END LICENSE BLOCK ***** */
+ 
+ /* Header file for oeICalTodoImpl.cpp containing its CID and CONTRACTID.*/
+
 #ifndef _OEICALTODOIMPL_H_
 #define _OEICALTODOIMPL_H_
 

calendar/libxpical/oeIICal.idl

@@ -36,6 +36,8 @@
  *
  * ***** END LICENSE BLOCK ***** */
 
+/* The Interface Description of all calendar objects listing various fields and methods of each */
+
 #include "nsISupports.idl"
 #include "nsISupportsArray.idl"
 

calendar/libxpical/token.c

@@ -38,6 +38,8 @@
 ** this software for any purpose.
 */
 
+/*This file was stolen from webtools/mozbot/uuidgen/token.c */
+
 #include <string.h>
 #include <stdio.h>
 #include <stdlib.h>

calendar/libxpical/token.h

@@ -38,6 +38,8 @@
 ** this software for any purpose.
 */
 
+/*This file was stolen from webtools/mozbot/uuidgen/token.h */
+
 #ifndef _TOKEN_H_
 #define _TOKEN_H_