Author: siwuzzz
Date: Mon Jul 2 14:17:08 2007
New Revision: 203
Modified:
trunk/clients/cs/src/core/atomfeed.cs
trunk/clients/cs/src/extensions/reminder.cs
Log:
src/core/atomfeed.cs, src/extensions/reminder.cs:
- Changed comments so they look better in the doc
Modified: trunk/clients/cs/src/core/atomfeed.cs
==============================================================================
--- trunk/clients/cs/src/core/atomfeed.cs (original)
+++ trunk/clients/cs/src/core/atomfeed.cs Mon Jul 2 14:17:08 2007
@@ -36,8 +36,11 @@
{
//////////////////////////////////////////////////////////////////////
- /// <summary>Base class to read gData feeds in Atom
+ /// <summary>Base class to read gData feeds in Atom</summary>
+ /// <remarks>
+ /// <para>
/// Version 1.0 changed to:
+ /// <code>
/// AtomFeed =
/// element atom:feed {
/// atomCommonAttributes,
@@ -56,22 +59,57 @@
/// extensionElement*),
/// atomEntry*
/// }
- /// in addition it holds:
- /// * opensearch:totalResults - the total number of search results
available (not necessarily all present in the feed).
- /// * opensearch:startIndex - the 1-based index of the first result.
- /// * opensearch:itemsPerPage - the maximum number of items that
appear on one page. This allows clients to generate direct links to any set of
subsequent pages.
- ///
+ /// </code>
+ /// In addition it holds:
+ /// <list type="bullet">
+ /// <item>
+ /// <term><c>opensearch:totalResults</c></term>
+ /// <description>Total number of search results available (not
necessarily all present in the feed).</description>
+ /// </item>
+ /// <item>
+ /// <term><c>opensearch:startIndex</c></term>
+ /// <description>The 1-based index of the first
result.</description>
+ /// </item>
+ /// <item>
+ /// <term><c>opensearch:itemsPerPage</c></term>
+ /// <description>The maximum number of items that appear on one
page. This allows clients to generate direct links to any set of subsequent
pages.</description>
+ /// </item>
+ /// </list>
+ /// </para>
+ /// <para>
/// In addition to these OpenSearch tags, the response also includes the
following Atom and gData tags:
- ///
- /// * atom:link rel="service.feed" type="application/atom+xml"
href="..."/> - specifies the URI where the complete Atom feed can be retrieved.
- /// * atom:link rel="service.feed" type="application/rss+xml"
href="..."/> - specifies the URI where the complete RSS feed can be retrieved.
- /// * atom:link rel="service.post" type="application/atom+xml"
href="..."/> - specifies the Atom feed PostURI (where new entries can be
posted).
- /// * atom:link rel="self" type="..." href="..."/> - contains the URI
of this search request. The type attribute depends on the requested format. If
no data changes, issuing a GET to this URI returns the same response.
- /// * atom:link rel="previous" type="application/atom+xml"
href="..."/> - specifies the URI of the previous chunk of this query resultset,
if it is chunked.
- /// * atom:link rel="next" type="application/atom+xml" href="..."/> -
specifies the URI of the next chunk of this query resultset, if it is chunked.
- /// * gdata:processed parameter="..."/> - one of these tags is
inserted for each parameter understood and processed by the service, e.g.
gdata:processed parameter="author"
- ///
- /// </summary>
+ /// <list type="bullet">
+ /// <item>
+ /// <term><c>atom:link rel="service.feed"
type="application/atom+xml" href="..."/></c></term>
+ /// <description>Specifies the URI where the complete Atom feed
can be retrieved.</description>
+ /// </item>
+ /// <item>
+ /// <term><c>atom:link rel="service.feed"
type="application/rss+xml" href="..."/></c></term>
+ /// <description>Specifies the URI where the complete RSS feed can
be retrieved.</description>
+ /// </item>
+ /// <item>
+ /// <term><c>atom:link rel="service.post"
type="application/atom+xml" href="..."/></c></term>
+ /// <description>Specifies the Atom feed PostURI (where new
entries can be posted).</description>
+ /// </item>
+ /// <item>
+ /// <term><c>atom:link rel="self" type="..."
href="..."/></c></term>
+ /// <description>Contains the URI of this search request. The type
attribute depends on the requested format. If no data changes, issuing a
<c>GET</c> to this URI returns the same response.</description>
+ /// </item>
+ /// <item>
+ /// <term><c>atom:link rel="previous" type="application/atom+xml"
href="..."/></c></term>
+ /// <description>Specifies the URI of the previous chunk of this
query resultset, if it is chunked.</description>
+ /// </item>
+ /// <item>
+ /// <term><c>atom:link rel="next" type="application/atom+xml"
href="..."/></c></term>
+ /// <description>Specifies the URI of the next chunk of this query
resultset, if it is chunked.</description>
+ /// </item>
+ /// <item>
+ /// <term><c>gdata:processed parameter="..."/></c></term>
+ /// <description>One of these tags is inserted for each parameter
understood and processed by the service, e.g. <c>gdata:processed
parameter="author"</c>.</description>
+ /// </item>
+ /// </list>
+ /// </para>
+ /// </remarks>
//////////////////////////////////////////////////////////////////////
#if WindowsCE || PocketPC
#else
Modified: trunk/clients/cs/src/extensions/reminder.cs
==============================================================================
--- trunk/clients/cs/src/extensions/reminder.cs (original)
+++ trunk/clients/cs/src/extensions/reminder.cs Mon Jul 2 14:17:08 2007
@@ -22,57 +22,82 @@
namespace Google.GData.Extensions {
/// <summary>
- /// GData schema extension describing a reminder on an event. You can
- /// represent a set of reminders where each has a (1) reminder period
- /// and (2) notification method. The method can be either "sms",
- /// "email", "alert", "none", "all".
- ///
- /// The meaning of this set of reminders differs based on whether you
- /// are reading or writing feeds. When reading, the set of reminders
- /// returned on an event takes into account both defaults on a
- /// parent recurring event (when applicable) as well as the user's
- /// defaults on calendar. If there are no gd:reminders returned that
- /// means the event has absolutely no reminders. "none" or "all" will
- /// not apply in this case.
- ///
- /// Writing is different because we have to be backwards-compatible
- /// (see *) with the old way of setting reminders. For easier analysis
- /// we describe all the behaviors defined in the table below. (Notice
- /// we only include cases for minutes, as the other cases specified in
- /// terms of days/hours/absoluteTime can be converted to this case.)
- ///
- /// Notice method is case-sensitive: must be in lowercase!
- ///
- /// no method method method=
- /// or method=all =none email|sms|alert
- ///
____________________________________________________________________________
- /// no gd:rem *no reminder N/A N/A
- ///
- /// 1 gd:rem *use user's no reminder InvalidEntryException
- /// def. settings
- ///
- /// 1 gd:rem min=0 *use user's no reminder InvalidEntryException
- /// def. settings
- ///
- /// 1 gd:rem min=-1 *no reminder no reminder InvalidEntryException
- ///
- /// 1 gd:rem min=+n *override with no reminder set exactly one
reminder
- /// +n for user's on event at +n with
given
- /// selected method
- /// methods
- ///
- /// multiple gd:rem InvalidEntry- InvalidEntry- copy this set exactly
- /// Exception Exception
- ///
- /// Hence, to override an event with a set of reminder time, method
- /// pairs, just specify them exactly. To clear an event of all
- /// overrides (and go back to inheriting the user's defaults), one can
- /// simply specify a single gd:reminder with no extra attributes. To
- /// have NO event reminders on an event, either set a single
- /// gd:reminder with negative reminder time, or simply update the event
- /// with a single gd:reminder method=none.
- ///
+ /// GData schema extension describing a reminder on an event.
/// </summary>
+ /// <remarks>
+ /// <para>You can represent a set of reminders where each has a (1)
reminder
+ /// period and (2) notification method. The method can be either "sms",
+ /// "email", "alert", "none", "all".</para>
+ ///
+ /// <para>The meaning of this set of reminders differs based on whether you
+ /// are reading or writing feeds. When reading, the set of reminders
+ /// returned on an event takes into account both defaults on a
+ /// parent recurring event (when applicable) as well as the user's
+ /// defaults on calendar. If there are no gd:reminders returned that
+ /// means the event has absolutely no reminders. "none" or "all" will
+ /// not apply in this case.</para>
+ ///
+ /// <para>Writing is different because we have to be backwards-compatible
+ /// (see *) with the old way of setting reminders. For easier analysis
+ /// we describe all the behaviors defined in the table below. (Notice
+ /// we only include cases for minutes, as the other cases specified in
+ /// terms of days/hours/absoluteTime can be converted to this case.)</para>
+ ///
+ /// <para>Notice method is case-sensitive: must be in lowercase!</para>
+ ///
+ /// <list type="table">
+ /// <listheader>
+ /// <term></term>
+ /// <term>No method or method=all</term>
+ /// <term>method=none</term>
+ /// <term>method=email|sms|alert</term>
+ /// </listheader>
+ /// <item>
+ /// <term>No gd:rem</term>
+ /// <term>*No reminder</term>
+ /// <term>N/A</term>
+ /// <term>N/A</term>
+ /// </item>
+ /// <item>
+ /// <term>1 gd:rem</term>
+ /// <term>*Use user's default settings</term>
+ /// <term>No reminder</term>
+ /// <term>InvalidEntryException</term>
+ /// </item>
+ /// <item>
+ /// <term>1 gd:rem min=0</term>
+ /// <term>*Use user's default settings</term>
+ /// <term>No reminder</term>
+ /// <term>InvalidEntryException</term>
+ /// </item>
+ /// <item>
+ /// <term>1 gd:rem min=-1</term>
+ /// <term>*No reminder</term>
+ /// <term>No reminder</term>
+ /// <term>InvalidEntryException</term>
+ /// </item>
+ /// <item>
+ /// <term>1 gd:rem min=+n</term>
+ /// <term>*Override with no +n for user's selected methods</term>
+ /// <term>No reminder</term>
+ /// <term>Set exactly one reminder on event at +n with given
method</term>
+ /// </item>
+ /// <item>
+ /// <term>Multiple gd:rem</term>
+ /// <term>InvalidEntryException</term>
+ /// <term>InvalidEntryException</term>
+ /// <term>Copy this set exactly</term>
+ /// </item>
+ /// </list>
+ ///
+ /// <para>Hence, to override an event with a set of reminder time, method
+ /// pairs, just specify them exactly. To clear an event of all
+ /// overrides (and go back to inheriting the user's defaults), one can
+ /// simply specify a single gd:reminder with no extra attributes. To
+ /// have NO event reminders on an event, either set a single
+ /// gd:reminder with negative reminder time, or simply update the event
+ /// with a single gd:reminder method=none.</para>
+ /// </remarks>
public class Reminder : IExtensionElement
{
/// <summary>
--~--~---------~--~----~------------~-------~--~----~
You received this message because you are subscribed to the Google Groups
"Google Data API" group.
To post to this group, send email to [email protected]
To unsubscribe from this group, send email to [EMAIL PROTECTED]
For more options, visit this group at
http://groups.google.com/group/google-help-dataapi?hl=en
-~----------~----~----~----~------~----~------~--~---
