[eog/gnome-2-26] Improve API documentation

[Felix Riemann <friemann src gnome org>]

commit c5ea3cd06a14c909d013d91093f9724905bf53ee
Author: Felix Riemann <friemann svn gnome org>
Date:   Sun Apr 26 17:37:22 2009 +0200

    Improve API documentation
    
    Improve API documentation for function parameters which had gtk-doc
    print lots of warnings.
---
 ChangeLog             |    4 ++++
 src/eog-application.c |   36 ++++++++++++++++++++----------------
 2 files changed, 24 insertions(+), 16 deletions(-)

diff --git a/ChangeLog b/ChangeLog
index d7cd02e..0d18ab5 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,7 @@
+2009-04-26  Felix Riemann  <friemann svn gnome org>
+
+	* src/eog-application.c: Improve API documentation.
+
 2009-04-26  Claudio Saavedra  <csaavedra igalia com>
 
 	* src/eog-metadata-reader-jpg.c: (eog_metadata_reader_jpg_consume):
diff --git a/src/eog-application.c b/src/eog-application.c
index af5a71b..f47e890 100644
--- a/src/eog-application.c
+++ b/src/eog-application.c
@@ -206,15 +206,16 @@ eog_application_get_empty_window (EogApplication *application)
 /**
  * eog_application_open_window:
  * @application: An #EogApplication.
- * @timestamp:
- * @flags:
- * @error:
+ * @timestamp: The timestamp of the user interaction which triggered this call
+ * (see gtk_window_present_with_time()).
+ * @flags: A set of #EogStartupFlags influencing a new windows' state.
+ * @error: Return location for a #GError, or NULL to ignore errors.
  *
  * Opens and presents an empty #EogWindow to the user. If there is
  * an empty window already open, this will be used. Otherwise, a
  * new one will be instantiated.
  *
- * Returns:
+ * Returns: %FALSE if @application is invalid, %TRUE otherwise
  **/
 gboolean
 eog_application_open_window (EogApplication  *application,
@@ -287,15 +288,16 @@ eog_application_show_window (EogWindow *window, gpointer user_data)
  * eog_application_open_file_list:
  * @application: An #EogApplication.
  * @file_list: A list of #GFile<!-- -->s.
- * @timestamp:
- * @flags:
- * @error:
+ * @timestamp: The timestamp of the user interaction which triggered this call
+ * (see gtk_window_present_with_time()).
+ * @flags: A set of #EogStartupFlags influencing a new windows' state.
+ * @error: Return location for a #GError, or NULL to ignore errors.
  *
  * Opens a list of files in a #EogWindow. If an #EogWindow displaying the first
  * image in the list is already open, this will be used. Otherwise, an empty
  * #EogWindow is used, either already existing or newly created.
  *
- * Returns:
+ * Returns: Currently always %TRUE.
  **/
 gboolean
 eog_application_open_file_list (EogApplication  *application,
@@ -336,14 +338,15 @@ eog_application_open_file_list (EogApplication  *application,
  * eog_application_open_uri_list:
  * @application: An #EogApplication.
  * @uri_list: A list of URIs.
- * @timestamp:
- * @flags:
- * @error:
+ * @timestamp: The timestamp of the user interaction which triggered this call
+ * (see gtk_window_present_with_time()).
+ * @flags: A set of #EogStartupFlags influencing a new windows' state.
+ * @error: Return location for a #GError, or NULL to ignore errors.
  *
  * Opens a list of images, from a list of URIs. See
  * eog_application_open_file_list() for details.
  *
- * Returns:
+ * Returns: Currently always %TRUE.
  **/
 gboolean
 eog_application_open_uri_list (EogApplication  *application,
@@ -370,14 +373,15 @@ eog_application_open_uri_list (EogApplication  *application,
  * eog_application_open_uris:
  * @application: an #EogApplication
  * @uris:  A #GList of URI strings.
- * @timestamp:
- * @flags:
- * @error:
+ * @timestamp: The timestamp of the user interaction which triggered this call
+ * (see gtk_window_present_with_time()).
+ * @flags: A set of #EogStartupFlags influencing a new windows' state.
+ * @error: Return location for a #GError, or NULL to ignore errors.
  *
  * Opens a list of images, from a list of URI strings. See
  * eog_application_open_file_list() for details.
  *
- * Returns:
+ * Returns: Currently always %TRUE.
  **/
 gboolean
 eog_application_open_uris (EogApplication  *application,