[CalendarServer-changes] [5291] CalendarServer/trunk/txcaldav/icalendarstore.py

[source_changes at macosforge.org]

Revision: 5291
          http://trac.macosforge.org/projects/calendarserver/changeset/5291
Author:   wsanchez at apple.com
Date:     2010-03-12 11:39:52 -0800 (Fri, 12 Mar 2010)
Log Message:
-----------
doc

Modified Paths:
--------------
    CalendarServer/trunk/txcaldav/icalendarstore.py

Modified: CalendarServer/trunk/txcaldav/icalendarstore.py
===================================================================
--- CalendarServer/trunk/txcaldav/icalendarstore.py	2010-03-12 19:26:20 UTC (rev 5290)
+++ CalendarServer/trunk/txcaldav/icalendarstore.py	2010-03-12 19:39:52 UTC (rev 5291)
@@ -50,6 +50,7 @@
 from twext.python.vcomponent import VComponent
 from txdav.idav import IPropertyStore
 
+
 #
 # Exceptions
 #
@@ -119,6 +120,7 @@
     Uh, oh.
     """
 
+
 #
 # Interfaces
 #
@@ -126,6 +128,11 @@
 class ICalendarHome(Interface):
     """
     Calendar home
+
+    A calendar home belongs to a specific principal and contains the
+    calendars which that principal has direct access to.  This
+    includes both calendars owned by the principal as well as
+    calendars that have been shared with and accepts by the principal.
     """
     def uid():
         """
@@ -178,9 +185,15 @@
         @return: an L{IPropertyStore}.
         """
 
+
 class ICalendar(Interface):
     """
     Calendar
+
+    A calendar is a container for calendar objects (events, to-dos,
+    etc.).  A calendar belongs to a specific principal but may be
+    shared with other principals, granting them read-only or
+    read/write access.
     """
     def ownerCalendarHome():
         """
@@ -292,9 +305,13 @@
         @return: an L{IPropertyStore}.
         """
 
+
 class ICalendarObject(Interface):
     """
-    Calendar object (event, to-do, etc.).
+    Calendar object
+
+    A calendar object decribes an event, to-do, or other iCalendar
+    object.
     """
     def setComponent(component):
         """
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.macosforge.org/pipermail/calendarserver-changes/attachments/20100312/bd270269/attachment.html>