capuchin r71 - in trunk: doc src/libcapuchin

[sebp svn gnome org]

Author: sebp
Date: Fri Mar 14 21:20:29 2008
New Revision: 71
URL: http://svn.gnome.org/viewvc/capuchin?rev=71&view=rev

Log:
Updated api doc

Modified:
   trunk/doc/api.txt
   trunk/src/libcapuchin/AppObject.cs

Modified: trunk/doc/api.txt
==============================================================================
--- trunk/doc/api.txt	(original)
+++ trunk/doc/api.txt	Fri Mar 14 21:20:29 2008
@@ -38,14 +38,14 @@
 ^^^^^^^
 
 - `UpdateFinished ()`
-    * Emited when the repository has been initialized after calling <<AppObject,AppObject>>.Update()
+    * Emitted when the repository has been initialized after calling <<AppObject,AppObject>>.Update()
 - `Status (action : STRING, plugin_id : STRING, progress : DOUBLE, speed : INTEGER)`
     * `action`: Current action (e.g. Downloading, Extracting)
     * `plugin_id`: The ID of the plugin that the status is related to
     * `progress`: The fraction of the progress that's complete (from 0 to 1), or -1.0 if no information is available on how long it will take
     * `speed`: Download speed
 - `InstallFinished (plugin_id : STRING)`
-    * Emited when the plugin has been downloaded and unpacked and is ready to be (re-)loaded by the application
+    * Emitted when the plugin has been downloaded and unpacked and is ready to be (re-)loaded by the application
 
 [[AppObject-methods]] 
 Methods
@@ -74,7 +74,7 @@
     * Update the plugin with ID `plugin_id`
     * This method will download the file and extract the archive, if neccessary.
     * In addition, it makes a checksum test, if the checksum is provided and verifies a GnuPG signature, if the signature is provided.
-    * During the download the `Status` signal will be emited
+    * During the download the `Status` signal will be emitted
     * The method emits the `InstallFinished` signal when it has finished installing the new plugin
     * Throws `RepositoryNotInitializedException` when `Update ()` hasn't been called before
     * Throws `NoSuchPluginException` when the given plugin is not in the repository

Modified: trunk/src/libcapuchin/AppObject.cs
==============================================================================
--- trunk/src/libcapuchin/AppObject.cs	(original)
+++ trunk/src/libcapuchin/AppObject.cs	Fri Mar 14 21:20:29 2008
@@ -83,7 +83,8 @@
         }
         
         /// <summary>Load the repository</summary>
-        /// <param name="force_update">Force downloading repository's XML file</param>
+        /// <param name="force_update">Whether to force to download the XML file from the server
+        /// or use the cached one, if no newer version is available</param>
 		/// <exception cref="Capuchin.RepositoryConnectionException">
         /// Thrown if connection to repository failed
         /// </exception>