Attachment 80831 Details for Bug 65755 – [PATCH v2 1/2] Doc: fix invalid usage of doxygen @param command

[patch] [PATCH v2 1/2] Doc: fix invalid usage of doxygen @param command

0001-Doc-fix-invalid-usage-of-doxygen-param-command.patch (text/plain), 3.86 KB, created by Chengwei Yang on 2013-06-15 00:43:34 UTC

(hide)

Description:

Filename:

MIME Type:

Creator: Chengwei Yang

Created: 2013-06-15 00:43:34 UTC

Size: 3.86 KB

patch

obsolete

>From 1a188dfea4e82af6eb86b4ebdf43610e84f2b31c Mon Sep 17 00:00:00 2001
>From: Chengwei Yang <chengwei.yang@intel.com>
>Date: Sat, 15 Jun 2013 08:21:52 +0800
>Subject: [PATCH v2 1/2] Doc: fix invalid usage of doxygen @param command
>
>Signed-off-by: Chengwei Yang <chengwei.yang@intel.com>
>---
> dbus/dbus-connection.c        |    2 +-
> dbus/dbus-shell.c             |   12 ++++++------
> dbus/dbus-sysdeps-unix.c      |    2 +-
> dbus/dbus-sysdeps-util-unix.c |    6 +++---
> 4 files changed, 11 insertions(+), 11 deletions(-)
>
>diff --git a/dbus/dbus-connection.c b/dbus/dbus-connection.c
>index 66315b3..0d017b3 100644
>--- a/dbus/dbus-connection.c
>+++ b/dbus/dbus-connection.c
>@@ -2150,7 +2150,7 @@ _dbus_connection_close_if_only_one_ref (DBusConnection *connection)
>  * relatively long time for memory, if they were only willing to block
>  * briefly then we retry for memory at a rapid rate.
>  *
>- * @timeout_milliseconds the timeout requested for blocking
>+ * @param timeout_milliseconds the timeout requested for blocking
>  */
> static void
> _dbus_memory_pause_based_on_timeout (int timeout_milliseconds)
>diff --git a/dbus/dbus-shell.c b/dbus/dbus-shell.c
>index 111d39d..3383e01 100644
>--- a/dbus/dbus-shell.c
>+++ b/dbus/dbus-shell.c
>@@ -150,7 +150,7 @@ unquote_string_inplace (char* str, char** end)
>  * through literally instead of being expanded). This function is
>  * guaranteed to succeed if applied to the result of
>  * _dbus_shell_quote(). If it fails, it returns %NULL.
>- * The @quoted_string need not actually contain quoted or
>+ * The @a quoted_string need not actually contain quoted or
>  * escaped text; _dbus_shell_unquote() simply goes through the string and
>  * unquotes/unescapes anything that the shell would. Both single and
>  * double quotes are handled, as are escapes including escaped
>@@ -163,7 +163,7 @@ unquote_string_inplace (char* str, char** end)
>  * be escaped with backslash. Otherwise double quotes preserve things
>  * literally.
>  *
>- * @quoted_string: shell-quoted string
>+ * @param quoted_string shell-quoted string
>  **/
> char*
> _dbus_shell_unquote (const char *quoted_string)
>@@ -544,10 +544,10 @@ tokenize_command_line (const char *command_line, DBusError *error)
>  * does contain such expansions, they are passed through
>  * literally. Free the returned vector with dbus_free_string_array().
>  * 
>- * @command_line: command line to parse
>- * @argcp: return location for number of args
>- * @argvp: return location for array of args
>- * @error: error information
>+ * @param command_line command line to parse
>+ * @param argcp return location for number of args
>+ * @param argvp return location for array of args
>+ * @param error error information
>  **/
> dbus_bool_t
> _dbus_shell_parse_argv (const char *command_line,
>diff --git a/dbus/dbus-sysdeps-unix.c b/dbus/dbus-sysdeps-unix.c
>index 07b761b..4a586c7 100644
>--- a/dbus/dbus-sysdeps-unix.c
>+++ b/dbus/dbus-sysdeps-unix.c
>@@ -1153,7 +1153,7 @@ _dbus_listen_unix_socket (const char     *path,
>  *
>  * This will set FD_CLOEXEC for the sockets returned.
>  *
>- * @oaram fds the file descriptors
>+ * @param fds the file descriptors
>  * @param error return location for errors
>  * @returns the number of file descriptors
>  */
>diff --git a/dbus/dbus-sysdeps-util-unix.c b/dbus/dbus-sysdeps-util-unix.c
>index 6265e2b..4d221b2 100644
>--- a/dbus/dbus-sysdeps-util-unix.c
>+++ b/dbus/dbus-sysdeps-util-unix.c
>@@ -381,13 +381,13 @@ _dbus_change_to_daemon_user  (const char    *user,
> 
> /**
>  * Attempt to ensure that the current process can open
>- * at least @limit file descriptors.
>+ * at least @a limit file descriptors.
>  *
>- * If @limit is lower than the current, it will not be
>+ * If @a limit is lower than the current, it will not be
>  * lowered.  No error is returned if the request can
>  * not be satisfied.
>  *
>- * @limit Number of file descriptors
>+ * @param limit number of file descriptors
>  */
> void
> _dbus_request_file_descriptor_limit (unsigned int limit)
>-- 
>1.7.9.5
>

Actions: View | Splinter Review

Attachments on bug 65755: 80810 | 80811 | 80831 | 80832 | 80838 | 80839 | 81112

Use of freedesktop.org services, including Bugzilla, is subject to our Code of Conduct. How we collect and use information is described in our Privacy Policy.