[113228] trunk/base/src

[toby at macports.org]

Revision: 113228
          https://trac.macports.org/changeset/113228
Author:   toby at macports.org
Date:     2013-11-12 15:25:56 -0800 (Tue, 12 Nov 2013)
Log Message:
-----------
Fix -Wdocumentation issues

Modified Paths:
--------------
    trunk/base/src/darwintracelib1.0/darwintrace.c
    trunk/base/src/pextlib1.0/filemap.c
    trunk/base/src/pextlib1.0/tracelib.c

Modified: trunk/base/src/darwintracelib1.0/darwintrace.c
===================================================================
--- trunk/base/src/darwintracelib1.0/darwintrace.c	2013-11-12 22:53:02 UTC (rev 113227)
+++ trunk/base/src/darwintracelib1.0/darwintrace.c	2013-11-12 23:25:56 UTC (rev 113228)
@@ -418,7 +418,6 @@
  * \param[in] op the operation (sent as-is to tracelib, should be interpreted
  *               as command)
  * \param[in] path the (not necessarily absolute) path to send to tracelib
- * \param[in] fd a FD to the file, or 0, if none available
  */
 static inline void __darwintrace_log_op(const char *op, const char *path) {
 	uint32_t size;
@@ -575,7 +574,7 @@
  * protocol and supports reading and returning an answer.
  *
  * \param[in] buf buffer to send to tracelib
- * \param[in] size size of the buffer to send
+ * \param[in] len size of the buffer to send
  * \param[in] answer boolean indicating whether an answer is expected and
  *                   should be returned
  * \return allocated answer buffer. Callers should free this buffer. If an

Modified: trunk/base/src/pextlib1.0/filemap.c
===================================================================
--- trunk/base/src/pextlib1.0/filemap.c	2013-11-12 22:53:02 UTC (rev 113227)
+++ trunk/base/src/pextlib1.0/filemap.c	2013-11-12 23:25:56 UTC (rev 113228)
@@ -312,7 +312,7 @@
  *
  * @param ioDatabaseBuffer	pointer to the buffer (where the node starts),
  *							updated by this function.
- * @param outTree			on output, a tree in memory.
+ * @param outNode			on output, a tree in memory.
  * @param ioBytesLeft		number of bytes remaining in the buffer (updated
  *							by this function).
  */
@@ -467,8 +467,8 @@
  * Save the database to the file.
  * This function saves the header and then calls SaveNode.
  *
- * @param inDatabaseFd	file descriptor of the open file (the cursor is reset)
- * @param inTree		tree of the database.
+ * @param inDatabasePath	file descriptor of the open file (the cursor is reset)
+ * @param inTree			tree of the database.
  */
 int
 Save(
@@ -930,7 +930,6 @@
  * @param outList		the list to populate with paths.
  * @param inSubpath		the path of the current root.
  * @param inSubpathLen	the length, without the terminator, of the path.
- * @return the list of paths which has value for their value.
  */
 void
 ListSubtree(

Modified: trunk/base/src/pextlib1.0/tracelib.c
===================================================================
--- trunk/base/src/pextlib1.0/tracelib.c	2013-11-12 22:53:02 UTC (rev 113227)
+++ trunk/base/src/pextlib1.0/tracelib.c	2013-11-12 23:25:56 UTC (rev 113228)
@@ -140,9 +140,9 @@
  * Different sockets should be used for different ports (and maybe even
  * phases).
  *
- * \param[inout] interp the Tcl interpreter
+ * \param[in,out] interp the Tcl interpreter
  * \param[in] objc the number of parameters
- * \param[in] the parameters
+ * \param[in] objv the parameters
  * \return a Tcl return code
  */
 static int TracelibSetNameCmd(Tcl_Interp *interp, int objc, Tcl_Obj *CONST objv[]) {
@@ -172,9 +172,9 @@
  * In variable;
  *  /dev/null\0/dev/tty\0/tmp:\0\0
  *
- * \param[inout] interp the Tcl interpreter
+ * \param[in,out] interp the Tcl interpreter
  * \param[in] objc the number of parameters
- * \param[in] the parameters
+ * \param[in] objv the parameters
  * \return a Tcl return code
  */
 static int TracelibSetSandboxCmd(Tcl_Interp *interp, int objc, Tcl_Obj *CONST objv[]) {
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.macosforge.org/pipermail/macports-changes/attachments/20131112/72684b0e/attachment.html>