[anjuta] libanjuta: documentation improvements

[Johannes Schmid <jhs src gnome org>]

commit 3595f2a43e5a4ac75fba127fa8a8737e91a81448
Author: Johannes Schmid <jhs gnome org>
Date:   Fri May 7 17:09:27 2010 +0200

    libanjuta: documentation improvements

 libanjuta/anjuta-async-notify.c       |   14 ++++++--------
 libanjuta/anjuta-plugin-manager.h     |    5 +++++
 libanjuta/anjuta-preferences-dialog.c |    1 +
 libanjuta/anjuta-preferences.c        |    2 +-
 libanjuta/anjuta-shell.h              |    4 ++++
 libanjuta/interfaces/libanjuta.idl    |   26 +++++++++++++-------------
 6 files changed, 30 insertions(+), 22 deletions(-)
---
diff --git a/libanjuta/anjuta-async-notify.c b/libanjuta/anjuta-async-notify.c
index 9578e7a..62b5596 100644
--- a/libanjuta/anjuta-async-notify.c
+++ b/libanjuta/anjuta-async-notify.c
@@ -116,11 +116,11 @@ anjuta_async_notify_new (void)
 /**
  * anjuta_async_notify_get_error:
  *
- * Gets the error set on @self.
- *
  * @self: An #AnjutaAsyncNotify object
  * @error: Return location for the error set by the called interface to which 
  *		   this object was passed. If no error is set, @error is set to NULL.
+ *
+ * Gets the error set on @self.
  */
 void
 anjuta_async_notify_get_error (AnjutaAsyncNotify *self, GError **error)
@@ -131,12 +131,11 @@ anjuta_async_notify_get_error (AnjutaAsyncNotify *self, GError **error)
 
 /**
  * anjuta_async_notify_set_error:
- *
- * Sets the error for an interface call. This method should only be used by 
- * interface implementations themselves, not by clients. 
- *
  * @self: An #AnjutaAsyncNotify object
  * @error: Error to set
+ *
+ * Sets the error for an interface call. This method should only be used by 
+ * interface implementations themselves, not by clients.  
  */
 void
 anjuta_async_notify_set_error (AnjutaAsyncNotify *self, GError *error)
@@ -149,11 +148,10 @@ anjuta_async_notify_set_error (AnjutaAsyncNotify *self, GError *error)
 
 /**
  * anjuta_async_notify_notify_finished:
+ * @self: An #AnjutaAsyncNotify object
  *
  * Emits the finished signal. This method should only be used by 
  * interface methods themselves, not by clients. 
- *
- * @self: An #AnjutaAsyncNotify object
  */
 void
 anjuta_async_notify_notify_finished (AnjutaAsyncNotify *self)
diff --git a/libanjuta/anjuta-plugin-manager.h b/libanjuta/anjuta-plugin-manager.h
index 3a73e75..08d95ce 100644
--- a/libanjuta/anjuta-plugin-manager.h
+++ b/libanjuta/anjuta-plugin-manager.h
@@ -35,6 +35,11 @@ G_BEGIN_DECLS
 #define ANJUTA_PLUGIN_MANAGER_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS ((obj), ANJUTA_TYPE_PLUGIN_MANAGER, AnjutaPluginManagerClass))
 #define ANJUTA_PLUGIN_MANAGER_ERROR            (anjuta_plugin_manager_error_quark())
 
+/**
+  * AnjutaPluginManagerError:
+  * @ANJUTA_PLUGIN_MANAGER_MISSING_FACTORY: The factory for the plugin couldn't be found
+  * @ANJUTA_PLUGIN_MANAGER_ERROR_UNKNOWN: Unknown error
+  */
 typedef enum
 {
 	ANJUTA_PLUGIN_MANAGER_MISSING_FACTORY,
diff --git a/libanjuta/anjuta-preferences-dialog.c b/libanjuta/anjuta-preferences-dialog.c
index 7307322..6fca129 100644
--- a/libanjuta/anjuta-preferences-dialog.c
+++ b/libanjuta/anjuta-preferences-dialog.c
@@ -241,6 +241,7 @@ anjuta_preferences_dialog_new (void)
  * anjuta_preferences_dialog_add_page:
  * @dlg: A #AnjutaPreferencesDialog object.
  * @name: Name of the preferences page.
+ * @title: Title of the page
  * @icon: Icon file name.
  * @page: page widget.
  *
diff --git a/libanjuta/anjuta-preferences.c b/libanjuta/anjuta-preferences.c
index f17ed31..a705f1d 100644
--- a/libanjuta/anjuta-preferences.c
+++ b/libanjuta/anjuta-preferences.c
@@ -1548,7 +1548,6 @@ anjuta_preferences_reset_defaults (AnjutaPreferences * pr)
 /**
  * anjuta_preferences_foreach:
  * @pr: A #AnjutaPreferences object.
- * @filter: Keys to filter out from the loop.
  * @callback: User callback function.
  * @data: User data passed to @callback
  *
@@ -1818,6 +1817,7 @@ anjuta_preferences_class_init (AnjutaPreferencesClass *class)
 
 /**
  * anjuta_preferences_new:
+ * @plugin_manager: #AnjutaPluginManager to be used
  * 
  * Creates a new #AnjutaPreferences object
  * 
diff --git a/libanjuta/anjuta-shell.h b/libanjuta/anjuta-shell.h
index bed4d8f..ad5e609 100644
--- a/libanjuta/anjuta-shell.h
+++ b/libanjuta/anjuta-shell.h
@@ -44,6 +44,10 @@ G_BEGIN_DECLS
 typedef struct _AnjutaShell      AnjutaShell;
 typedef struct _AnjutaShellIface AnjutaShellIface;
 
+/**
+ * AnjutaShellError_
+ * @ANJUTA_SHELL_ERROR_DOESNT_EXIST:
+ */
 typedef enum
 {
 	ANJUTA_SHELL_ERROR_DOESNT_EXIST,
diff --git a/libanjuta/interfaces/libanjuta.idl b/libanjuta/interfaces/libanjuta.idl
index 7b808dd..f608c3e 100644
--- a/libanjuta/interfaces/libanjuta.idl
+++ b/libanjuta/interfaces/libanjuta.idl
@@ -114,7 +114,7 @@ interface IAnjutaFile
 		/**
 		 * ianjuta_file_savable_set_dirty:
 		 * @obj: Self
-		 * @dirty: 
+		 * @dirty: Whether the file was edited or not
 		 * @err: Error propagation and reporting
 		 * 
 		 * if @dirty is TRUE, sets dirty for the content. Save point will be
@@ -2332,7 +2332,7 @@ interface IAnjutaEditor
 	interface IAnjutaEditorGoto
 	{
 		/**
-		 * ianjuta_editor_goto_start_block()
+		 * ianjuta_editor_goto_start_block:
 		 * @obj: Self
 		 * @err: Error propagation and reporting
 		 *
@@ -2341,7 +2341,7 @@ interface IAnjutaEditor
 		void start_block();
 		
 		/**
-		 * ianjuta_editor_goto_end_block()
+		 * ianjuta_editor_goto_end_block:
 		 * @obj: Self
 		 * @err: Error propagation and reporting
 		 *
@@ -2350,7 +2350,7 @@ interface IAnjutaEditor
 		void end_block();
 
 		/**
-		 * ianjuta_editor_goto_matching_brace()
+		 * ianjuta_editor_goto_matching_brace:
 		 * @obj: Self
 		 * @err: Error propagation and reporting
 		 *
@@ -5187,7 +5187,6 @@ interface IAnjutaSymbol
 	
 	/** 
 	 * IAnjutaSymbolType:
-	 *
 	 * @IANJUTA_SYMBOL_TYPE_UNDEF: Unknown type. If you have to search for all the known
 	 * types use this flag because it's quicker than #IANJUTA_SYMBOL_TYPE_MAX.
 	 * @IANJUTA_SYMBOL_TYPE_CLASS: Class declaration
@@ -5242,10 +5241,7 @@ interface IAnjutaSymbol
 	}
 
 	/** 
-	 * IAnjutaSymbolField: Field masks. Used mainly to retrieve the fields of a symbol
-	 * throught the call to ianjuta_symbol_get_extra_info_string () or the various
-	 * ianjuta_symbol_manager_* () functions.
-	 *
+	 * IAnjutaSymbolField:
 	 * @IANJUTA_SYMBOL_FIELD_SIMPLE: With this field you will have name, line of declaration,
 	 *                               is_file_scope and signature of the symbol.
 	 * @IANJUTA_SYMBOL_FIELD_FILE_PATH: The path to the file. It's obtained using something like
@@ -5266,6 +5262,10 @@ interface IAnjutaSymbol
 	 * @IANJUTA_SYMBOL_FIELD_FILE_INCLUDE: field mainly ignored.
 	 * @IANJUTA_SYMBOL_FIELD_PROJECT_NAME: the project this symbol belongs to.
 	 * @IANJUTA_SYMBOL_FIELD_WORKSPACE_NAME: the workspace this symbol belongs to.
+	 *
+	 * Field masks. Used mainly to retrieve the fields of a symbol
+	 * throught the call to ianjuta_symbol_get_extra_info_string () or the various
+	 * ianjuta_symbol_manager_* () functions
 	 */
 	enum Field
 	{
@@ -5517,13 +5517,13 @@ interface IAnjutaSymbolManager
 	
 	/** 
 	 * IAnjutaSymbolManagerSearchFileScope: 
- 	 * You cannot use bitwise OR in this parameter.	 
-	 *
 	 * @IANJUTA_SYMBOL_MANAGER_SEARCH_FS_IGNORE: to be ignored (e.g. Will search both private and public scopes). 
 	 * @IANJUTA_SYMBOL_MANAGER_SEARCH_FS_PUBLIC: only global public function will be searched 
  	 * (the ones that _do not_ belong to the file scope). 
 	 * @IANJUTA_SYMBOL_MANAGER_SEARCH_FS_PRIVATE: only private or static (for C language) will be searched 
      * (the ones that _do_ belong to the file scope). 
+     *
+     * You cannot use bitwise OR in this parameter.
 	 */	
 	enum SearchFileScope
 	{
@@ -5587,7 +5587,7 @@ interface IAnjutaSymbolManager
 	IAnjutaIterable* search_system (IAnjutaSymbolType match_types, gboolean include_types, IAnjutaSymbolField info_fields, const gchar *pattern, SearchFileScope filescope_search, gint results_limit, gint results_offset);
 
 	/**
-	* ianjuta_symbol_manager_search_project_async:
+	* ianjuta_symbol_manager_search_system_async:
 	* @obj: Self
 	* @match_types: If passed #IANJUTA_SYMBOL_TYPE_UNDEF the function will not perfom any filter.
 	* @include_types: Should the result contain or exclude the match_types? TRUE to include them,
@@ -5750,7 +5750,7 @@ interface IAnjutaSymbolManager
 	IAnjutaIterable* get_members (const IAnjutaSymbol *symbol, IAnjutaSymbolField info_fields);
 	
 	/**
-	* ianjuta_symbol_manager_get_parents:
+	* ianjuta_symbol_manager_get_class_parents:
 	* @obj: Self
 	* @symbol: Symbol which you want to know the parent classes of.
 	* @info_fields: Kind of infos you would like to have available on the resulting Symbols.