This is an archive of the discontinued LLVM Phabricator instance.

Differential D11379

[LLDB] Fix incorrect documentation directives and some parameters
ClosedPublic

Authored by Eugene.Zelenko on Jul 20 2015, 6:57 PM.

Details

Reviewers
clayborg
labath
Commits
rGd0bf8313100f: Fix incorrect documentation directives and some parameters
rLLDB242765: Fix incorrect documentation directives and some parameters
Summary

I checked this patch on my own build.

Please check it in if it's OK, because I don't have SVN write access.

Diff Detail

Event Timeline

Eugene.Zelenko updated this revision to Diff 30227.Jul 20 2015, 6:57 PM
Eugene.Zelenko retitled this revision from to [LLDB] Fix incorrect documentation directives and some parameters.
Eugene.Zelenko updated this object.
Eugene.Zelenko added reviewers: labath, clayborg.
labath accepted this revision.Jul 21 2015, 2:37 AM
labath edited edge metadata.

lgtm, I'll commit this.

This revision is now accepted and ready to land.Jul 21 2015, 2:37 AM
Eugene.Zelenko closed this revision.Jul 21 2015, 10:52 AM

Closed by commit r242765: Fix incorrect documentation directives and some parameters by labath.

Revision Contents

PathSize
include/
lldb/
Core/
2 lines
Expression/
2 lines
Host/
24 lines
Interpreter/
4 lines
Symbol/
2 lines
Target/
4 lines

Diff 30227

include/lldb/Core/DataEncoder.h

Context not available.
/// The offset in bytes into the contained data at which to /// The offset in bytes into the contained data at which to
/// start encoding. /// start encoding.
/// ///
/// @param[int] src /// @param[in] src
/// The buffer that contains the bytes to encode. /// The buffer that contains the bytes to encode.
/// ///
/// @param[in] src_len /// @param[in] src_len
Context not available.

include/lldb/Expression/ClangUserExpression.h

Context not available.
/// If non-NULL, a C string containing translation-unit level /// If non-NULL, a C string containing translation-unit level
/// definitions to be included when the expression is parsed. /// 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. /// If execution is successful, the result valobj is placed here.
/// ///
/// @param[out] /// @param[out]
Context not available.

include/lldb/Host/File.h

Context not available.
/// path. If \a path is not NULL or empty, this function will call /// path. If \a path is not NULL or empty, this function will call
/// File::Open (const char *path, uint32_t options, uint32_t permissions). /// File::Open (const char *path, uint32_t options, uint32_t permissions).
/// ///
/// @param[in] path /// @param[in] filespec
/// The FileSpec for this file. /// The FileSpec for this file.
/// ///
/// @param[in] options /// @param[in] options
Context not available.
/// @param[in] buf /// @param[in] buf
/// A buffer where to put the bytes that are read. /// 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 /// The number of bytes to read form the current file position
/// which gets modified with the number of bytes that were read. /// which gets modified with the number of bytes that were read.
/// ///
Context not available.
/// @param[in] buf /// @param[in] buf
/// A buffer where to put the bytes that are read. /// 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 /// The number of bytes to write to the current file position
/// which gets modified with the number of bytes that were /// which gets modified with the number of bytes that were
/// written. /// written.
Context not available.
/// @see File::Read (void *, size_t, off_t &) /// @see File::Read (void *, size_t, off_t &)
/// @see File::Write (const 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 /// The offset to seek to within the file relative to the
/// end of the file which gets filled in with the resulting /// end of the file which gets filled in with the resulting
/// absolute file offset. /// absolute file offset.
Context not available.
/// own file position markers and reads on other threads won't mess /// own file position markers and reads on other threads won't mess
/// up the current read. /// up the current read.
/// ///
/// @param[in] buf /// @param[in] dst
/// A buffer where to put the bytes that are read. /// 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 /// The number of bytes to read form the current file position
/// which gets modified with the number of bytes that were read. /// 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 /// The offset within the file from which to read \a num_bytes
/// bytes. This offset gets incremented by the number of bytes /// bytes. This offset gets incremented by the number of bytes
/// that were read. /// that were read.
Context not available.
/// own file position markers and reads on other threads won't mess /// own file position markers and reads on other threads won't mess
/// up the current read. /// 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 /// The number of bytes to read form the current file position
/// which gets modified with the number of bytes that were read. /// 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 /// The offset within the file from which to read \a num_bytes
/// bytes. This offset gets incremented by the number of bytes /// bytes. This offset gets incremented by the number of bytes
/// that were read. /// that were read.
Context not available.
/// their own locking externally to avoid multiple people writing /// their own locking externally to avoid multiple people writing
/// to the file at the same time. /// to the file at the same time.
/// ///
/// @param[in] buf /// @param[in] src
/// A buffer containing the bytes to write. /// 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. /// The number of bytes to write to the file at offset \a offset.
/// \a num_bytes gets modified with the number of bytes that /// \a num_bytes gets modified with the number of bytes that
/// were read. /// were read.
/// ///
/// @param[in/out] offset /// @param[in,out] offset
/// The offset within the file at which to write \a num_bytes /// The offset within the file at which to write \a num_bytes
/// bytes. This offset gets incremented by the number of bytes /// bytes. This offset gets incremented by the number of bytes
/// that were written. /// that were written.
Context not available.

include/lldb/Interpreter/CommandInterpreter.h

Context not available.
/// ///
/// @param[in] commands /// @param[in] commands
/// The list of commands to execute. /// 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 /// The execution context in which to run the commands. Can be NULL in which case the default
/// context will be used. /// context will be used.
/// @param[in] options /// @param[in] options
Context not available.
/// ///
/// @param[in] file /// @param[in] file
/// The file from which to read in commands. /// 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 /// The execution context in which to run the commands. Can be NULL in which case the default
/// context will be used. /// context will be used.
/// @param[in] options /// @param[in] options
Context not available.

include/lldb/Symbol/Block.h

Context not available.
/// added to the variable list until there are no parent blocks /// added to the variable list until there are no parent blocks
/// or the parent block has inlined function info. /// 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 /// All variables in this block, and optionally all parent
/// blocks will be added to this list. /// blocks will be added to this list.
/// ///
Context not available.

include/lldb/Target/Process.h

Context not available.
/// that a block that isn't set writable can still be written on from lldb, /// that a block that isn't set writable can still be written on from lldb,
/// just not by the process itself. /// just not by the process itself.
/// ///
/// @param[in/out] error /// @param[in,out] error
/// An error object to fill in if things go wrong. /// An error object to fill in if things go wrong.
/// @return /// @return
/// The address of the allocated buffer in the process, or /// The address of the allocated buffer in the process, or
Context not available.
/// @param[in] stream /// @param[in] stream
/// The output stream to get the state change description /// 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. /// 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 /// Else this variable will be set to \b true or \b false to indicate if the process
/// needs to have its process IOHandler popped. /// needs to have its process IOHandler popped.
Context not available.