Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Add more comments

  • Loading branch information...
commit d084b263212e24d263d74e74bda3e28dbd982634 1 parent f793e85
Daniel Lo Nigro authored
4 NTelepathy/Dbus/Constants.cs
View
@@ -23,7 +23,9 @@ public abstract class Constants
/// Interface for accounts.
/// </summary>
public const string ACCOUNT_INTERFACE = "org.freedesktop.Telepathy.Account";
-
+ /// <summary>
+ /// Interface for SimplePresence.
+ /// </summary>
public const string SIMPLEPRESENCE_INTERFACE = "org.freedesktop.Telepathy.Connection.Interface.SimplePresence";
}
}
19 NTelepathy/Dbus/DbusBase.cs
View
@@ -8,6 +8,10 @@ namespace NTelepathy
{
public abstract class DbusBase
{
+ /// <summary>
+ /// Gets or sets the properties implementation for this object
+ /// </summary>
+ /// <value>The properties object</value>
public Properties Properties { get; set; }
/*protected string Interface
@@ -21,11 +25,26 @@ public abstract class DbusBase
}
}*/
+ /// <summary>
+ /// Gets the value of the specified property.
+ /// </summary>
+ /// <returns>The property value</returns>
+ /// <param name='interface'>Interface to get property from</param>
+ /// <param name='name'>Property name</param>
+ /// <typeparam name='T'>Type of the property</typeparam>
protected T GetProperty<T>(string @interface, string name)
{
return (T)Properties.Get(@interface, name);
}
+ /// <summary>
+ /// Gets the value of the specified object property.
+ /// </summary>
+ /// <returns>The property value</returns>
+ /// <param name='interface'>Interface to get property from</param>
+ /// <param name='name'>Property name</param>
+ /// <param name='bus_name'>Name of the bus to get the object from</param>
+ /// <typeparam name='T'>Type of the property</typeparam>
protected T GetProperty<T>(string @interface, string name, string bus_name) where T : DbusBase
{
ObjectPath path = GetProperty<ObjectPath>(@interface, name);
14 NTelepathy/Dbus/DbusHelper.cs
View
@@ -7,6 +7,13 @@ namespace NTelepathy
{
public static class DbusHelper
{
+ /// <summary>
+ /// Gets the specified DBus object along with its properties object
+ /// </summary>
+ /// <returns>The DBus object</returns>
+ /// <param name='bus_name'>Name of the bus to get the object from</param>
+ /// <param name='path'>Path to the object</param>
+ /// <typeparam name='T'>Type of the object</typeparam>
public static T GetWithProperties<T>(string bus_name, ObjectPath path) where T : DbusBase
{
T obj = Bus.Session.GetObject<T>(bus_name, path);
@@ -15,6 +22,13 @@ public static class DbusHelper
return obj;
}
+ /// <summary>
+ /// Gets the specified DBus objects along with their properties objects
+ /// </summary>
+ /// <returns>The DBus objects</returns>
+ /// <param name='bus_name'>Name of the bus to get the object from</param>
+ /// <param name='paths'>Paths to the object</param>
+ /// <typeparam name='T'>Type of the objects</typeparam>
public static IEnumerable<T> GetWithProperties<T>(string bus_name, ObjectPath[] paths) where T : DbusBase
{
IList<T> results = new List<T>(paths.Length);
6 NTelepathy/Telepathy.cs
View
@@ -4,8 +4,14 @@
namespace NTelepathy
{
+ /// <summary>
+ /// Base Telepathy class
+ /// </summary>
public static class Telepathy
{
+ /// <summary>
+ /// Get the Telepathy AccountManager
+ /// </summary>
public static AccountManager AccountManager
{
get
Please sign in to comment.
Something went wrong with that request. Please try again.