[PATCH] Fix doxygen syntax error. Change inout to in,out
Wald Commits
scm-commit at wald.intevation.org
Mon Sep 29 16:42:33 CEST 2014
# HG changeset patch
# User Andre Heinecke <andre.heinecke at intevation.de>
# Date 1412001726 -7200
# Node ID 82fab0c689bfead6ea8bb8755f03c4e2889efa27
# Parent 78637257f547fc20593a2fb7edc15b480b91776b
Fix doxygen syntax error. Change inout to in,out
diff -r 78637257f547 -r 82fab0c689bf cinst/nss-secitemlist.h
--- a/cinst/nss-secitemlist.h Mon Sep 29 16:38:09 2014 +0200
+++ b/cinst/nss-secitemlist.h Mon Sep 29 16:42:06 2014 +0200
@@ -35,7 +35,7 @@
* @brief Prepend a new SECItem to list
*
* The data will be copied.
- * @param[inout] list pointer to the list to which the item will be added.
+ * @param[in,out] list pointer to the list to which the item will be added.
* @param[in] item the SECItem to add to the list.
*/
void seciteml_push (seciteml_t **list, SECItem *item);
@@ -43,7 +43,7 @@
/**
* @brief Remove and return first SECItem from list
*
- * @param[inout] list pointer to the list to which the item will be added.
+ * @param[in,out] list pointer to the list to which the item will be added.
* @returns the removed item, or NULL if list is empty.
* The caller shoud free this item after use.
*/
@@ -54,7 +54,7 @@
*
* Frees a secitem list
*
- * @param[inout] list pointer to the list which should be freed. set to NULL
+ * @param[in,out] list pointer to the list which should be freed. set to NULL
*/
void seciteml_free (seciteml_t **list);
diff -r 78637257f547 -r 82fab0c689bf common/portpath.h
--- a/common/portpath.h Mon Sep 29 16:38:09 2014 +0200
+++ b/common/portpath.h Mon Sep 29 16:42:06 2014 +0200
@@ -23,7 +23,7 @@
* @brief portable version of dirname
* @details return the directory component of the given path.
* The argument path may be altered by the function.
- * @param[inout] path the pathname
+ * @param[in,out] path the pathname
* @returns a pointer to the string containing the directory component
*/
char *port_dirname(char *path);
diff -r 78637257f547 -r 82fab0c689bf common/strhelp.h
--- a/common/strhelp.h Mon Sep 29 16:38:09 2014 +0200
+++ b/common/strhelp.h Mon Sep 29 16:42:06 2014 +0200
@@ -49,7 +49,7 @@
/**
* @brief append a string to a NULL terminated array of strings.
*
- * @param[inout] pArray pointer to the NULL terminated list of string pointers.
+ * @param[in,out] pArray pointer to the NULL terminated list of string pointers.
* @param[in] string pointer to the string to append to the list.
* @param[in] len length of the string to append to the list
*/
@@ -58,8 +58,8 @@
/**
* @brief append a string to another string.
*
- * @param[inout] pDst pointer to the string to be extended.
- * @param[inout] dst_len length of the dst string. Will be modified.
+ * @param[in,out] pDst pointer to the string to be extended.
+ * @param[in,out] dst_len length of the dst string. Will be modified.
* @param[in] appendage pointer to the string to append.
* @param[in] len length of the string to append.
*/
@@ -68,7 +68,7 @@
/**
* @brief Frees the given %NULL-terminated string array.
- * @param[inout] str_array a %NULL-terminated array of strings
+ * @param[in,out] str_array a %NULL-terminated array of strings
*/
void strv_free (char **str_array);
@@ -93,7 +93,7 @@
* @details the start of the string is trimmed by setting *s to the
* first non white space character. The end is trimmed by setting the
* first character after the last non white space character to \0.
- * @param[inout] s ponter to the string to strip
+ * @param[in,out] s ponter to the string to strip
*/
bool str_trim (char **s);
diff -r 78637257f547 -r 82fab0c689bf ui/downloader_win.cpp
--- a/ui/downloader_win.cpp Mon Sep 29 16:38:09 2014 +0200
+++ b/ui/downloader_win.cpp Mon Sep 29 16:42:06 2014 +0200
@@ -126,7 +126,7 @@
/** @brief open a session with appropriate proxy settings
*
- * @param[inout] *pHSession pointer to a HInternet structure
+ * @param[in,out] *pHSession pointer to a HInternet structure
*
* On error call getLastError to get extended error information.
*
@@ -190,7 +190,7 @@
/** @brief initialize a connection in the session
*
* @param[in] HSession the session to work in.
- * @param[inout] *pHConnect pointer to the connection.
+ * @param[in,out] *pHConnect pointer to the connection.
* @param[in] url pointer to the URL in wchar representation.
*
* On error call getLastError to get extended error information.
@@ -216,7 +216,7 @@
*
* @param[in] HSession the session to work in.
* @param[in] HConnect the connection to use.
- * @param[inout] *pHRequest pointer to the request structure to be filled.
+ * @param[in,out] *pHRequest pointer to the request structure to be filled.
* @param[in] requestType the HTTP request to be made default is GET
* @param[in] resource pointer to the resource to request in wchar
* representation.
diff -r 78637257f547 -r 82fab0c689bf ui/sslconnection_bare.h
--- a/ui/sslconnection_bare.h Mon Sep 29 16:38:09 2014 +0200
+++ b/ui/sslconnection_bare.h Mon Sep 29 16:42:06 2014 +0200
@@ -86,7 +86,7 @@
* This removes the headers from the byte array passed as
* parameter.
*
- * @param[inout] data: The response to parse.
+ * @param[in,out] data: The response to parse.
*
* @returns: A map of the header fields. Or an empty map on error.
*/
More information about the Trustbridge-commits
mailing list