Author: fmantek
Date: Fri Sep 7 06:44:18 2007
New Revision: 238
Modified:
trunk/clients/cs/src/VS2003/gextension/gextension.csproj
trunk/clients/cs/src/core/service.cs
trunk/clients/cs/src/extensions/exif.cs
trunk/clients/cs/src/extensions/mediarss.cs
trunk/clients/cs/src/extensions/simplecontainer.cs
trunk/clients/cs/src/extensions/simpleelement.cs
trunk/clients/cs/src/gphotos/gextphotos.cs
trunk/clients/cs/src/gphotos/photofeed.cs
trunk/clients/cs/src/gphotos/picasaquery.cs
trunk/clients/cs/src/gphotos/picasaservice.cs
Log:
Documentation and project file updates
Modified: trunk/clients/cs/src/VS2003/gextension/gextension.csproj
==============================================================================
--- trunk/clients/cs/src/VS2003/gextension/gextension.csproj (original)
+++ trunk/clients/cs/src/VS2003/gextension/gextension.csproj Fri Sep 7
06:44:18 2007
@@ -139,6 +139,12 @@
BuildAction = "Compile"
/>
<File
+ RelPath = "exif.cs"
+ Link = "..\..\extensions\exif.cs"
+ SubType = "Code"
+ BuildAction = "Compile"
+ />
+ <File
RelPath = "extcollections.cs"
Link = "..\..\extensions\extcollections.cs"
SubType = "Code"
@@ -181,6 +187,12 @@
BuildAction = "Compile"
/>
<File
+ RelPath = "mediarss.cs"
+ Link = "..\..\extensions\mediarss.cs"
+ SubType = "Code"
+ BuildAction = "Compile"
+ />
+ <File
RelPath = "originalevent.cs"
Link = "..\..\extensions\originalevent.cs"
SubType = "Code"
@@ -201,6 +213,12 @@
<File
RelPath = "reminder.cs"
Link = "..\..\extensions\reminder.cs"
+ SubType = "Code"
+ BuildAction = "Compile"
+ />
+ <File
+ RelPath = "simplecontainer.cs"
+ Link = "..\..\extensions\simplecontainer.cs"
SubType = "Code"
BuildAction = "Compile"
/>
Modified: trunk/clients/cs/src/core/service.cs
==============================================================================
--- trunk/clients/cs/src/core/service.cs (original)
+++ trunk/clients/cs/src/core/service.cs Fri Sep 7 06:44:18 2007
@@ -416,6 +416,7 @@
/// <param name="uriTarget"></param>
/// <param name="input"></param>
/// <param name="contentType"></param>
+ /// <param name="slugHeader">the value for the slug header, indicating
filenaming</param>
/// <returns>AtomEntry</returns>
public AtomEntry Update(Uri uriTarget, Stream input, string
contentType, string slugHeader)
{
@@ -433,6 +434,7 @@
/// <param name="uriTarget"></param>
/// <param name="input"></param>
/// <param name="contentType"></param>
+ /// <param name="slugHeader">the value for the slug header, indicating
filenaming</param>
/// <returns>AtomEntry</returns>
public AtomEntry Insert(Uri uriTarget, Stream input, string
contentType, string slugHeader)
{
Modified: trunk/clients/cs/src/extensions/exif.cs
==============================================================================
--- trunk/clients/cs/src/extensions/exif.cs (original)
+++ trunk/clients/cs/src/extensions/exif.cs Fri Sep 7 06:44:18 2007
@@ -27,12 +27,19 @@
/// </summary>
public class ExifExtensions
{
+ /// <summary>
+ /// adds all ExifExtensions to the passed in baseObject
+ /// </summary>
+ /// <param name="baseObject"></param>
public static void AddExtension(AtomBase baseObject)
{
baseObject.AddExtension(new ExifTags());
}
}
+ /// <summary>
+ /// short table for constants related to exif xml declarations
+ /// </summary>
public class ExifNameTable
{
/// <summary>static string to specify the exif namespace
@@ -49,6 +56,9 @@
/// </summary>
public class ExifTags : SimpleContainer
{
+ /// <summary>
+ /// base constructor, creates an exif:tags representation
+ /// </summary>
public ExifTags() :
base("tags",
ExifNameTable.ExifPrefix,
@@ -72,9 +82,17 @@
/// </summary>
public class ExifDistance : SimpleElement
{
+ /// <summary>
+ /// basse constructor for exif:distance
+ /// </summary>
public ExifDistance()
: base("distance", ExifNameTable.ExifPrefix, ExifNameTable.NSExif)
{}
+
+ /// <summary>
+ /// base constructor taking an initial value
+ /// </summary>
+ /// <param name="initValue"></param>
public ExifDistance(string initValue)
: base("distance", ExifNameTable.ExifPrefix, ExifNameTable.NSExif,
initValue)
{}
@@ -85,9 +103,17 @@
/// </summary>
public class ExifExposure : SimpleElement
{
+ /// <summary>
+ /// basse constructor for exif:exposure
+ /// </summary>
public ExifExposure()
: base("exposure", ExifNameTable.ExifPrefix, ExifNameTable.NSExif)
{}
+
+ /// <summary>
+ /// base constructor taking an initial value
+ /// </summary>
+ /// <param name="initValue"></param>
public ExifExposure(string initValue)
: base("exposure", ExifNameTable.ExifPrefix, ExifNameTable.NSExif,
initValue)
{}
@@ -98,9 +124,17 @@
/// </summary>
public class ExifFlash : SimpleElement
{
+ /// <summary>
+ /// basse constructor for exif:flash
+ /// </summary>
public ExifFlash()
: base("flash", ExifNameTable.ExifPrefix, ExifNameTable.NSExif)
{}
+
+ /// <summary>
+ /// base constructor taking an initial value
+ /// </summary>
+ /// <param name="initValue"></param>
public ExifFlash(string initValue)
: base("flash", ExifNameTable.ExifPrefix, ExifNameTable.NSExif,
initValue)
{}
@@ -111,9 +145,17 @@
/// </summary>
public class ExifFocalLength : SimpleElement
{
+ /// <summary>
+ /// basse constructor for exif:focallength
+ /// </summary>
public ExifFocalLength()
: base("focallength", ExifNameTable.ExifPrefix, ExifNameTable.NSExif)
{}
+
+ /// <summary>
+ /// base constructor taking an initial value
+ /// </summary>
+ /// <param name="initValue"></param>
public ExifFocalLength(string initValue)
: base("focallength", ExifNameTable.ExifPrefix, ExifNameTable.NSExif,
initValue)
{}
@@ -124,9 +166,16 @@
/// </summary>
public class ExifFStop : SimpleElement
{
+ /// <summary>
+ /// basse constructor for exif:fstop
+ /// </summary>
public ExifFStop()
: base("fstop", ExifNameTable.ExifPrefix, ExifNameTable.NSExif)
{}
+ /// <summary>
+ /// base constructor taking an initial value
+ /// </summary>
+ /// <param name="initValue"></param>
public ExifFStop(string initValue)
: base("fstop", ExifNameTable.ExifPrefix, ExifNameTable.NSExif,
initValue)
{}
@@ -137,9 +186,16 @@
/// </summary>
public class ExifImageUniqueID : SimpleElement
{
+ /// <summary>
+ /// basse constructor for exif:imageUniqueID
+ /// </summary>
public ExifImageUniqueID()
: base("imageUniqueID", ExifNameTable.ExifPrefix, ExifNameTable.NSExif)
{}
+ /// <summary>
+ /// base constructor taking an initial value
+ /// </summary>
+ /// <param name="initValue"></param>
public ExifImageUniqueID(string initValue)
: base("imageUniqueID", ExifNameTable.ExifPrefix,
ExifNameTable.NSExif, initValue)
{}
@@ -150,9 +206,16 @@
/// </summary>
public class ExifISO : SimpleElement
{
+ /// <summary>
+ /// basse constructor for exif:iso
+ /// </summary>
public ExifISO()
: base("iso", ExifNameTable.ExifPrefix, ExifNameTable.NSExif)
{}
+ /// <summary>
+ /// base constructor taking an initial value
+ /// </summary>
+ /// <param name="initValue"></param>
public ExifISO(string initValue)
: base("iso", ExifNameTable.ExifPrefix, ExifNameTable.NSExif,
initValue)
{}
@@ -163,9 +226,16 @@
/// </summary>
public class ExifMake : SimpleElement
{
+ /// <summary>
+ /// basse constructor for exif:make
+ /// </summary>
public ExifMake()
: base("make", ExifNameTable.ExifPrefix, ExifNameTable.NSExif)
{}
+ /// <summary>
+ /// base constructor taking an initial value
+ /// </summary>
+ /// <param name="initValue"></param>
public ExifMake(string initValue)
: base("make", ExifNameTable.ExifPrefix, ExifNameTable.NSExif,
initValue)
{}
@@ -176,9 +246,16 @@
/// </summary>
public class ExifModel : SimpleElement
{
+ /// <summary>
+ /// basse constructor for exif:model
+ /// </summary>
public ExifModel()
: base("model", ExifNameTable.ExifPrefix, ExifNameTable.NSExif)
{}
+ /// <summary>
+ /// base constructor taking an initial value
+ /// </summary>
+ /// <param name="initValue"></param>
public ExifModel(string initValue)
: base("model", ExifNameTable.ExifPrefix, ExifNameTable.NSExif,
initValue)
{}
@@ -189,9 +266,16 @@
/// </summary>
public class ExifTime : SimpleElement
{
+ /// <summary>
+ /// basse constructor for exif:time
+ /// </summary>
public ExifTime()
: base("time", ExifNameTable.ExifPrefix, ExifNameTable.NSExif)
{}
+ /// <summary>
+ /// base constructor taking an initial value
+ /// </summary>
+ /// <param name="initValue"></param>
public ExifTime(string initValue)
: base("time", ExifNameTable.ExifPrefix, ExifNameTable.NSExif,
initValue)
{}
Modified: trunk/clients/cs/src/extensions/mediarss.cs
==============================================================================
--- trunk/clients/cs/src/extensions/mediarss.cs (original)
+++ trunk/clients/cs/src/extensions/mediarss.cs Fri Sep 7 06:44:18 2007
@@ -27,6 +27,10 @@
/// </summary>
public class MediaRssExtensions
{
+ /// <summary>
+ /// helper to add all MediaRss extensions to a base object
+ /// </summary>
+ /// <param name="baseObject"></param>
public static void AddExtension(AtomBase baseObject)
{
baseObject.AddExtension(new MediaGroup());
@@ -34,6 +38,9 @@
}
+ /// <summary>
+ /// short table for constants related to mediaRss declarations
+ /// </summary>
public class MediaRssNameTable
{
/// <summary>static string to specify the mediarss namespace
@@ -64,6 +71,9 @@
/// </summary>
public class MediaGroup : SimpleContainer
{
+ /// <summary>
+ /// default constructor for media:group
+ /// </summary>
public MediaGroup() :
base(MediaRssNameTable.MediaRssGroup,
MediaRssNameTable.mediaRssPrefix,
@@ -84,12 +94,19 @@
/// </summary>
public class MediaCredit : SimpleElement
{
+ /// <summary>
+ /// default constructor for media:credit
+ /// </summary>
public MediaCredit()
: base(MediaRssNameTable.MediaRssCredit,
MediaRssNameTable.mediaRssPrefix,
MediaRssNameTable.NSMediaRss)
{}
+ /// <summary>
+ /// default constructor for media:credit with an initial value
+ /// </summary>
+ /// <param name="initValue"/>
public MediaCredit(string initValue)
: base(MediaRssNameTable.MediaRssCredit,
MediaRssNameTable.mediaRssPrefix,
@@ -103,6 +120,9 @@
/// </summary>
public class MediaDescription : SimpleElement
{
+ /// <summary>
+ /// default constructor for media:description
+ /// </summary>
public MediaDescription()
: base(MediaRssNameTable.MediaRssDescription,
MediaRssNameTable.mediaRssPrefix,
@@ -111,6 +131,10 @@
this.Attributes.Add("type", null);
}
+ /// <summary>
+ /// default constructor for media:description with an initial value
+ /// </summary>
+ /// <param name="initValue"/>
public MediaDescription(string initValue)
: base(MediaRssNameTable.MediaRssDescription,
MediaRssNameTable.mediaRssPrefix,
@@ -127,6 +151,9 @@
/// </summary>
public class MediaContent : SimpleElement
{
+ /// <summary>
+ /// default constructor for media:content
+ /// </summary>
public MediaContent()
: base(MediaRssNameTable.MediaRssContent,
MediaRssNameTable.mediaRssPrefix,
@@ -148,12 +175,19 @@
/// </summary>
public class MediaKeywords : SimpleElement
{
+ /// <summary>
+ /// default constructor for media:keywords
+ /// </summary>
public MediaKeywords()
: base(MediaRssNameTable.MediaRssKeywords,
MediaRssNameTable.mediaRssPrefix,
MediaRssNameTable.NSMediaRss)
{}
+ /// <summary>
+ /// default constructor for media:keywords with an initial value
+ /// </summary>
+ /// <param name="initValue"/>
public MediaKeywords(string initValue)
: base(MediaRssNameTable.MediaRssKeywords,
MediaRssNameTable.mediaRssPrefix,
@@ -168,6 +202,9 @@
/// </summary>
public class MediaThumbnail : SimpleElement
{
+ /// <summary>
+ /// default constructor for media:thumbnail
+ /// </summary>
public MediaThumbnail()
: base(MediaRssNameTable.MediaRssThumbnail,
MediaRssNameTable.mediaRssPrefix,
@@ -183,6 +220,9 @@
/// </summary>
public class MediaTitle : SimpleElement
{
+ /// <summary>
+ /// default constructor for media:title
+ /// </summary>
public MediaTitle()
: base(MediaRssNameTable.MediaRssTitle,
MediaRssNameTable.mediaRssPrefix,
@@ -191,6 +231,10 @@
this.Attributes.Add("type", null);
}
+ /// <summary>
+ /// default constructor for media:title with an initial value
+ /// </summary>
+ /// <param name="initValue"/>
public MediaTitle(string initValue)
: base(MediaRssNameTable.MediaRssTitle,
MediaRssNameTable.mediaRssPrefix,
Modified: trunk/clients/cs/src/extensions/simplecontainer.cs
==============================================================================
--- trunk/clients/cs/src/extensions/simplecontainer.cs (original)
+++ trunk/clients/cs/src/extensions/simplecontainer.cs Fri Sep 7 06:44:18 2007
@@ -40,6 +40,10 @@
{
}
+ /// <summary>
+ /// copy constructor, used in parsing
+ /// </summary>
+ /// <param name="original"></param>
protected SimpleContainer(SimpleContainer original) :
base(original.XmlName, original.XmlPrefix, original.XmlNameSpace)
{
Modified: trunk/clients/cs/src/extensions/simpleelement.cs
==============================================================================
--- trunk/clients/cs/src/extensions/simpleelement.cs (original)
+++ trunk/clients/cs/src/extensions/simpleelement.cs Fri Sep 7 06:44:18 2007
@@ -136,6 +136,10 @@
get { return this.xmlPrefix; }
}
+ /// <summary>
+ /// debugging helper
+ /// </summary>
+ /// <returns></returns>
public override string ToString()
{
return base.ToString() + " for: " + XmlNameSpace + "- " + XmlName;
@@ -245,7 +249,7 @@
for (int i=0; i < this.Attributes.Count; i++)
{
string name = this.Attributes.GetKey(i) as string;
- string value = getAttribute(node, name);
+ string value = this.Attributes.GetByIndex(i) as string;
writer.WriteAttributeString(name, value);
}
}
Modified: trunk/clients/cs/src/gphotos/gextphotos.cs
==============================================================================
--- trunk/clients/cs/src/gphotos/gextphotos.cs (original)
+++ trunk/clients/cs/src/gphotos/gextphotos.cs Fri Sep 7 06:44:18 2007
@@ -22,8 +22,16 @@
namespace Google.GData.Photos {
+ /// <summary>
+ /// helper to instantiate all factories defined in here and attach
+ /// them to a base object
+ /// </summary>
public class GPhotoExtensions
{
+ /// <summary>
+ /// helper to add all picasa photo extensions to the base object
+ /// </summary>
+ /// <param name="baseObject"></param>
public static void AddExtension(AtomBase baseObject)
{
baseObject.AddExtension(new GPhotoAlbumId());
Modified: trunk/clients/cs/src/gphotos/photofeed.cs
==============================================================================
--- trunk/clients/cs/src/gphotos/photofeed.cs (original)
+++ trunk/clients/cs/src/gphotos/photofeed.cs Fri Sep 7 06:44:18 2007
@@ -25,7 +25,26 @@
//////////////////////////////////////////////////////////////////////
/// <summary>
- /// Feed API customization class for defining feeds in an Event feed.
+ /// Picasa Web Albums provides a variety of representations of photo-
+ /// and album-related data. There are three independent axes for
+ /// specifying what you want when you request data: visibility,
projection, and path/kind.
+ /// Visibility values let you request data at various levels of sharing.
+ /// For example, a visibility value of public requests publicly visible
data.
+ /// For a list of values, see Visibility values, below. The default
visibility
+ /// depends on whether the request is authenticated or not.
+ /// Projection values let you indicate what elements and extensions
+ /// should appear in the feed you're requesting. For example, a projection
+ /// value of base indicates that the representation is a basic Atom feed
+ /// without any extension elements, suitable for display in an Atom
reader.
+ /// You must specify a projection value. Path and kind values let you
indicate what
+ /// type of items you want information about. For example, a path of
user/liz
+ /// and a kind value of tag requests a feed of tags associated with the
+ /// user whose username is liz. Path and kind values are separate parts of
the
+ /// URI, but they're used together to indicate the item type(s) desired.
+ /// You must specify a path, but kind is optional; the default kind
depends on the path.
+ /// To request a particular representation, you specify a visibility
value,
+ /// a projection value, and a path and kind in the URI that you send
+ /// to Picasa Web Albums.
/// </summary>
//////////////////////////////////////////////////////////////////////
public class PhotoFeed : AbstractFeed
Modified: trunk/clients/cs/src/gphotos/picasaquery.cs
==============================================================================
--- trunk/clients/cs/src/gphotos/picasaquery.cs (original)
+++ trunk/clients/cs/src/gphotos/picasaquery.cs Fri Sep 7 06:44:18 2007
@@ -39,23 +39,75 @@
public class PicasaQuery : FeedQuery
{
+ /// <summary>
+ /// The kind parameter lets you request information about a particular
kind
+ /// of item. The parameter value should be a comma-separated list of
requested kinds.
+ /// If you omit the kind parameter, Picasa Web Albums chooses a
default kind
+ /// depending on the level of feed you're requesting. For a user-based
feed,
+ /// the default kind is album; for an album-based feed, the default
kind is
+ /// photo; for a photo-based feed, the default kind is comment; for a
community
+ /// search feed, the default kind is photo.
+ /// </summary>
public enum Kinds
{
+ /// <summary>
+ /// Feed includes some or all of the albums the specified
+ /// user has in their gallery. Which albums are returned
+ /// depends on the visibility value specified.
+ /// </summary>
album,
+
+ /// <summary>
+ /// Feed includes the photos in an album (album-based),
+ /// recent photos uploaded by a user (user-based) or
+ /// photos uploaded by all users (community search).
+ /// </summary>
photo,
+ /// <summary>
+ /// Feed includes the comments that have been made on a photo.
+ /// </summary>
comment,
+ /// <summary>
+ /// Includes all tags associated with the specified user, album,
+ /// or photo. For user-based and album-based feeds, the tags
+ /// include a weight value indicating how often they occurred.
+ /// </summary>
tag,
+ /// <summary>
+ /// using none implies the server default
+ /// </summary>
none
}
+ /// <summary>
+ /// describing the visibility level of picasa feeds
+ /// </summary>
public enum AccessLevel
{
+ /// <summary>
+ /// no parameter. Setting the accessLevel to undefined
+ /// implies the server default
+ /// </summary>
AccessUndefined,
+ /// <summary>
+ /// Shows both public and private data.
+ /// Requires authentication. Default for authenticated users.
+ /// </summary>
AccessAll,
+ /// <summary>
+ /// Shows only private data. Requires authentication.
+ /// </summary>
AccessPrivate,
+ /// <summary>
+ /// Shows only public data.
+ /// Does not require authentication. Default for unauthenticated
users.
+ /// </summary>
AccessPublic,
}
+ /// <summary>
+ /// holds the 2 potential kind parameters a query can have
+ /// </summary>
protected Kinds[] kinds = new Kinds[2];
private AccessLevel access;
private string thumbsize;
@@ -88,7 +140,7 @@
//////////////////////////////////////////////////////////////////////
- /// <summary>indicates the kinds to retrieve
+ /// <summary>indicates the kinds to retrieve</summary>
/// <returns> </returns>
//////////////////////////////////////////////////////////////////////
public virtual Kinds[] KindParameter
@@ -98,9 +150,8 @@
}
// end of accessor public WebAlbumKinds
-
//////////////////////////////////////////////////////////////////////
- /// <summary>indicates the access
- /// <returns> </returns>
+ //////////////////////////////////////////////////////////////////////
+ /// <summary>indicates the access</summary>
//////////////////////////////////////////////////////////////////////
public AccessLevel Access
{
@@ -111,7 +162,7 @@
//////////////////////////////////////////////////////////////////////
- /// <summary>indicates the thumbsize required
+ /// <summary>indicates the thumbsize required</summary>
/// <returns> </returns>
//////////////////////////////////////////////////////////////////////
public string Thumbsize
Modified: trunk/clients/cs/src/gphotos/picasaservice.cs
==============================================================================
--- trunk/clients/cs/src/gphotos/picasaservice.cs (original)
+++ trunk/clients/cs/src/gphotos/picasaservice.cs Fri Sep 7 06:44:18 2007
@@ -32,11 +32,51 @@
/// </summary>
public class PicasaService : Service
{
+ //////////////////////////////////////////////////////////////////////
+ /// <summary>
+ /// Picasa Web Albums provides a variety of representations of photo-
+ /// and album-related data. There are three independent axes for
+ /// specifying what you want when you request data: visibility,
projection, and path/kind.
+ /// Visibility values let you request data at various levels of
sharing.
+ /// For example, a visibility value of public requests publicly
visible data.
+ /// For a list of values, see Visibility values, below. The default
visibility
+ /// depends on whether the request is authenticated or not.
+ /// Projection values let you indicate what elements and extensions
+ /// should appear in the feed you're requesting. For example, a
projection
+ /// value of base indicates that the representation is a basic Atom
feed
+ /// without any extension elements, suitable for display in an Atom
reader.
+ /// You must specify a projection value. Path and kind values let you
indicate what
+ /// type of items you want information about. For example, a path of
user/liz
+ /// and a kind value of tag requests a feed of tags associated with
the
+ /// user whose username is liz. Path and kind values are separate
parts of the
+ /// URI, but they're used together to indicate the item type(s)
desired.
+ /// You must specify a path, but kind is optional; the default kind
depends on the path.
+ /// To request a particular representation, you specify a visibility
value,
+ /// a projection value, and a path and kind in the URI that you send
+ /// to Picasa Web Albums.
+ /// </summary>
+ //////////////////////////////////////////////////////////////////////
public enum PicasaFeed
{
+ /// <summary>
+ /// he user-based feed represents data associated with a
particular user. A user-based feed can
+ /// contain either album, or tag or photo kinds, which you can
request using the kind parameter.
+ /// </summary>
UserFeed,
+ /// <summary>
+ /// The album-based feed represents an album and any kinds
associated with the album.
+ /// An album-based feed can contain either photo or tag kinds,
which you can request
+ /// using the kind parameter.
+ /// </summary>
AlbumFeed,
+ /// <summary>
+ /// The photo-based feed provides a list of comments or tags
+ /// associated with the specified photo.
+ /// </summary>
PhotoFeed,
+ /// <summary>
+ /// the Unknownfeed is the "not set" of this enum value
+ /// </summary>
UnknownFeed
}
/// <summary>This service's User-Agent string</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
-~----------~----~----~----~------~----~------~--~---
