Fix incorrect documentation directives and some parameters

Differential Revision: http://reviews.llvm.org/D11379

Patch by Eugene Zelenko.

llvm-svn: 242765

diff --git a/lldb/include/lldb/Core/DataEncoder.h b/lldb/include/lldb/Core/DataEncoder.h
index 7889f41..8b4727e 100644 (file)
--- a/lldb/include/lldb/Core/DataEncoder.h
+++ b/lldb/include/lldb/Core/DataEncoder.h
@@ -252,7 +252,7 @@ public:
     ///     The offset in bytes into the contained data at which to
     ///     start encoding.
     ///
-    /// @param[int] src
+    /// @param[in] src
     ///     The buffer that contains the bytes to encode.
     ///
     /// @param[in] src_len

diff --git a/lldb/include/lldb/Expression/ClangUserExpression.h b/lldb/include/lldb/Expression/ClangUserExpression.h
index a549f5e..425ba62 100644 (file)
--- a/lldb/include/lldb/Expression/ClangUserExpression.h
+++ b/lldb/include/lldb/Expression/ClangUserExpression.h
@@ -285,7 +285,7 @@ public:
     ///     If non-NULL, a C string containing translation-unit level
     ///     definitions to be included when the expression is parsed.
     ///
-    /// @param[in/out] result_valobj_sp
+    /// @param[in,out] result_valobj_sp
     ///      If execution is successful, the result valobj is placed here.
     ///
     /// @param[out]

diff --git a/lldb/include/lldb/Host/File.h b/lldb/include/lldb/Host/File.h
index 5747cb5..62a7050 100644 (file)
--- a/lldb/include/lldb/Host/File.h
+++ b/lldb/include/lldb/Host/File.h
@@ -104,7 +104,7 @@ public:
     /// path. If \a path is not NULL or empty, this function will call
     /// File::Open (const char *path, uint32_t options, uint32_t permissions).
     ///
-    /// @param[in] path
+    /// @param[in] filespec
     ///     The FileSpec for this file.
     ///
     /// @param[in] options
@@ -247,7 +247,7 @@ public:
     /// @param[in] buf
     ///     A buffer where to put the bytes that are read.
     ///
-    /// @param[in/out] num_bytes
+    /// @param[in,out] num_bytes
     ///     The number of bytes to read form the current file position
     ///     which gets modified with the number of bytes that were read.
     ///
@@ -268,7 +268,7 @@ public:
     /// @param[in] buf
     ///     A buffer where to put the bytes that are read.
     ///
-    /// @param[in/out] num_bytes
+    /// @param[in,out] num_bytes
     ///     The number of bytes to write to the current file position
     ///     which gets modified with the number of bytes that were 
     ///     written.
@@ -335,7 +335,7 @@ public:
     /// @see File::Read (void *, size_t, off_t &)
     /// @see File::Write (const void *, size_t, off_t &)
     ///
-    /// @param[in/out] offset
+    /// @param[in,out] offset
     ///     The offset to seek to within the file relative to the 
     ///     end of the file which gets filled in with the resulting
     ///     absolute file offset.
@@ -357,14 +357,14 @@ public:
     /// own file position markers and reads on other threads won't mess
     /// up the current read.
     ///
-    /// @param[in] buf
+    /// @param[in] dst
     ///     A buffer where to put the bytes that are read.
     ///
-    /// @param[in/out] num_bytes
+    /// @param[in,out] num_bytes
     ///     The number of bytes to read form the current file position
     ///     which gets modified with the number of bytes that were read.
     ///
-    /// @param[in/out] offset
+    /// @param[in,out] offset
     ///     The offset within the file from which to read \a num_bytes
     ///     bytes. This offset gets incremented by the number of bytes
     ///     that were read.
@@ -383,11 +383,11 @@ public:
     /// own file position markers and reads on other threads won't mess
     /// up the current read.
     ///
-    /// @param[in/out] num_bytes
+    /// @param[in,out] num_bytes
     ///     The number of bytes to read form the current file position
     ///     which gets modified with the number of bytes that were read.
     ///
-    /// @param[in/out] offset
+    /// @param[in,out] offset
     ///     The offset within the file from which to read \a num_bytes
     ///     bytes. This offset gets incremented by the number of bytes
     ///     that were read.
@@ -419,15 +419,15 @@ public:
     /// their own locking externally to avoid multiple people writing
     /// to the file at the same time.
     ///
-    /// @param[in] buf
+    /// @param[in] src
     ///     A buffer containing the bytes to write.
     ///
-    /// @param[in/out] num_bytes
+    /// @param[in,out] num_bytes
     ///     The number of bytes to write to the file at offset \a offset.
     ///     \a num_bytes gets modified with the number of bytes that 
     ///     were read.
     ///
-    /// @param[in/out] offset
+    /// @param[in,out] offset
     ///     The offset within the file at which to write \a num_bytes
     ///     bytes. This offset gets incremented by the number of bytes
     ///     that were written.

diff --git a/lldb/include/lldb/Interpreter/CommandInterpreter.h b/lldb/include/lldb/Interpreter/CommandInterpreter.h
index 1962050..0b555b5 100644 (file)
--- a/lldb/include/lldb/Interpreter/CommandInterpreter.h
+++ b/lldb/include/lldb/Interpreter/CommandInterpreter.h
@@ -337,7 +337,7 @@ public:
     ///
     /// @param[in] commands
     ///    The list of commands to execute.
-    /// @param[in/out] context 
+    /// @param[in,out] context
     ///    The execution context in which to run the commands.  Can be NULL in which case the default
     ///    context will be used.
     /// @param[in] options
@@ -358,7 +358,7 @@ public:
     ///
     /// @param[in] file
     ///    The file from which to read in commands.
-    /// @param[in/out] context 
+    /// @param[in,out] context
     ///    The execution context in which to run the commands.  Can be NULL in which case the default
     ///    context will be used.
     /// @param[in] options

diff --git a/lldb/include/lldb/Symbol/Block.h b/lldb/include/lldb/Symbol/Block.h
index 59671b0..0dd3a3f 100644 (file)
--- a/lldb/include/lldb/Symbol/Block.h
+++ b/lldb/include/lldb/Symbol/Block.h
@@ -330,7 +330,7 @@ public:
     ///     added to the variable list until there are no parent blocks
     ///     or the parent block has inlined function info.
     ///
-    /// @param[in/out] variable_list
+    /// @param[in,out] variable_list
     ///     All variables in this block, and optionally all parent
     ///     blocks will be added to this list.
     ///

diff --git a/lldb/include/lldb/Target/Process.h b/lldb/include/lldb/Target/Process.h
index d03c17c..b9c93bb 100644 (file)
--- a/lldb/include/lldb/Target/Process.h
+++ b/lldb/include/lldb/Target/Process.h
@@ -2389,7 +2389,7 @@ public:
     ///     that a block that isn't set writable can still be written on from lldb,
     ///     just not by the process itself.
     ///
-    /// @param[in/out] error
+    /// @param[in,out] error
     ///     An error object to fill in if things go wrong.
     /// @return
     ///     The address of the allocated buffer in the process, or
@@ -2871,7 +2871,7 @@ public:
     /// @param[in] stream
     ///     The output stream to get the state change description
     ///
-    /// @param[inout] pop_process_io_handler
+    /// @param[in,out] pop_process_io_handler
     ///     If this value comes in set to \b true, then pop the Process IOHandler if needed.
     ///     Else this variable will be set to \b true or \b false to indicate if the process
     ///     needs to have its process IOHandler popped.