[geany/geany] 1be0bc: Mark output parameters as such

[Colomban Wendling]

Branch:      refs/heads/master
Author:      Colomban Wendling <ban at herbesfolles.org>
Committer:   Colomban Wendling <ban at herbesfolles.org>
Date:        Sun, 28 Feb 2016 01:03:04 UTC
Commit:      1be0bc7c74606cf590c4c8a18a99a9c7daddfd1e
             https://github.com/geany/geany/commit/1be0bc7c74606cf590c4c8a18a99a9c7daddfd1e

Log Message:
-----------
Mark output parameters as such


Modified Paths:
--------------
    src/encodings.c
    src/spawn.c
    src/utils.c

Modified: src/encodings.c
2 lines changed, 1 insertions(+), 1 deletions(-)
===================================================================
@@ -775,7 +775,7 @@ static gchar *encodings_convert_to_utf8_with_suggestion(const gchar *buffer, gss
  *
  *  @param buffer the input string to convert.
  *  @param size the length of the string, or -1 if the string is nul-terminated.
- *  @param used_encoding return location of the detected encoding of the input string, or @c NULL.
+ *  @param used_encoding @out @optional return location of the detected encoding of the input string, or @c NULL.
  *
  *  @return If the conversion was successful, a newly allocated nul-terminated string,
  *    which must be freed with @c g_free(). Otherwise @c NULL.


Modified: src/spawn.c
6 lines changed, 3 insertions(+), 3 deletions(-)
===================================================================
@@ -709,7 +709,7 @@ static gboolean spawn_async_with_pipes(const gchar *working_directory, const gch
  *  @param command_line child program and arguments, or @c NULL.
  *  @param argv child's argument vector, or @c NULL.
  *  @param envp child's environment, or @c NULL.
- *  @param child_pid return location for child process ID, or @c NULL.
+ *  @param child_pid @out @optional return location for child process ID, or @c NULL.
  *  @param error return location for error.
  *
  *  @return @c TRUE on success, @c FALSE on error.
@@ -993,7 +993,7 @@ static void spawn_watch_cb(GPid pid, gint status, gpointer data)
  *  @param stderr_max_length maximum data length to pass to stderr_cb, @c 0 = default.
  *  @param exit_cb callback to invoke when the child exits, or @c NULL.
  *  @param exit_data data to pass to @a exit_cb.
- *  @param child_pid return location for child process ID, or @c NULL.
+ *  @param child_pid @out @optional return location for child process ID, or @c NULL.
  *  @param error return location for error.
  *
  *  @return @c TRUE on success, @c FALSE on error.
@@ -1190,7 +1190,7 @@ static void spawn_get_exit_status_cb(G_GNUC_UNUSED GPid pid, gint status, gpoint
  *  @param stdin_data data to send to childs's stdin, or @c NULL.
  *  @param stdout_data GString location to receive the child's stdout, or NULL.
  *  @param stderr_data GString location to receive the child's stderr, or NULL.
- *  @param exit_status return location for the child exit code, or NULL.
+ *  @param exit_status @out @optional return location for the child exit code, or @c NULL.
  *  @param error return location for error.
  *
  *  @return @c TRUE on success, @c FALSE on error.


Modified: src/utils.c
6 lines changed, 3 insertions(+), 3 deletions(-)
===================================================================
@@ -1653,9 +1653,9 @@ const gchar *utils_get_default_dir_utf8(void)
  *  @param flags Ignored.
  *  @param child_setup @girskip Ignored.
  *  @param user_data @girskip Ignored.
- *  @param std_out The return location for child output, or @c NULL.
- *  @param std_err The return location for child error messages, or @c NULL.
- *  @param exit_status The child exit status, as returned by waitpid(), or @c NULL.
+ *  @param std_out @out @optional The return location for child output, or @c NULL.
+ *  @param std_err @out @optional The return location for child error messages, or @c NULL.
+ *  @param exit_status @out @optional The child exit status, as returned by waitpid(), or @c NULL.
  *  @param error The return location for error or @c NULL.
  *
  *  @return @c TRUE on success, @c FALSE if an error was set.



--------------
This E-Mail was brought to you by github_commit_mail.py (Source: https://github.com/geany/infrastructure).