Magic-Mirror/llvm-capstone
1
0
Fork 0
mirror of https://github.com/capstone-engine/llvm-capstone.git synced 2025-01-09 01:29:52 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

[lldb][NFC] Fix several -Wdocumentation warnings

Browse Source 
The GetOffset documentation was copied from the function above
so I completely deleted that one. The rest was just outdated
documentation that didn't keep up with renamed or changed
function parameters/return types.
This commit is contained in:
Raphael Isemann 2020-02-27 11:16:16 +01:00
parent e58229fded
commit 2affdcee61
7 changed files with 14 additions and 44 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
lldb/include/lldb/Breakpoint/BreakpointResolver.h
View File

@ -65,12 +65,6 @@ public:
/// The offset to add to all locations.
void SetOffset(lldb::addr_t offset);
/// This updates the offset for this breakpoint. All the locations
/// currently set for this breakpoint will have their offset adjusted when
/// this is called.
///
/// \param[in] offset
/// The offset to add to all locations.
lldb::addr_t GetOffset() const { return m_offset; }
/// In response to this method the resolver scans all the modules in the

12
lldb/include/lldb/Host/common/NativeProcessProtocol.h
View File

@ -379,16 +379,10 @@ public:
/// \param[in] traceid
/// The user id of the tracing instance.
///
/// \param[in] config
/// The thread id of the tracing instance, in case configuration
/// for a specific thread is needed should be specified in the
/// config.
///
/// \param[out] error
/// Status indicates what went wrong.
///
/// \param[out] config
/// The actual configuration being used for tracing.
/// The configuration being used for tracing.
///
/// \return A status indicating what went wrong.
virtual Status GetTraceConfig(lldb::user_id_t traceid, TraceOptions &config) {
return Status("Not implemented");
}

4
lldb/include/lldb/Target/Thread.h
View File

@ -177,8 +177,6 @@ public:
/// to force the thread to run (e.g. the "thread continue" command, or are
/// resetting the state
/// (e.g. in SBThread::Resume()), then pass true to override_suspend.
/// \return
/// The User resume state for this thread.
void SetResumeState(lldb::StateType state, bool override_suspend = false) {
if (m_resume_state == lldb::eStateSuspended && !override_suspend)
return;
@ -1157,7 +1155,7 @@ public:
/// Some Thread subclasses may maintain a token to help with providing
/// an extended backtrace. The SystemRuntime plugin will set/request this.
///
/// \param [in] token
/// \param [in] token The extended backtrace token.
virtual void SetExtendedBacktraceToken(uint64_t token) {}
/// Gets the extended backtrace token for this thread

22
lldb/include/lldb/Utility/Broadcaster.h
View File

@ -259,19 +259,6 @@ public:
void CheckInWithManager();
/// Broadcast an event which has no associated data.
///
/// \param[in] event_type
/// The element from the enum defining this broadcaster's events
/// that is being broadcast.
///
/// \param[in] event_data
/// User event data that will be owned by the lldb::Event that
/// is created internally.
///
/// \param[in] unique
/// If true, then only add an event of this type if there isn't
/// one already in the queue.
///
void BroadcastEvent(lldb::EventSP &event_sp) {
m_broadcaster_sp->BroadcastEvent(event_sp);
}
@ -308,7 +295,7 @@ public:
/// different from what is requested in \a event_mask, and to track this the
/// actual event bits that are acquired get returned.
///
/// \param[in] listener
/// \param[in] listener_sp
/// The Listener object that wants to monitor the events that
/// get broadcast by this object.
///
@ -347,9 +334,6 @@ public:
/// \param[in] event_mask
/// A bit mask that indicates which events the listener is
/// asking to monitor.
///
/// \return
/// The NULL terminated C string name of this Broadcaster.
void SetEventName(uint32_t event_mask, const char *name) {
m_broadcaster_sp->SetEventName(event_mask, name);
}
@ -367,7 +351,7 @@ public:
/// (assuming \a listener was listening to this object) for other listener
/// objects to use.
///
/// \param[in] listener
/// \param[in] listener_sp
/// A Listener object that previously called AddListener.
///
/// \param[in] event_mask
@ -389,7 +373,7 @@ public:
/// now go to the hijacking listener. Only one hijack can occur at a time.
/// If we need more than this we will have to implement a Listener stack.
///
/// \param[in] listener
/// \param[in] listener_sp
/// A Listener object. You do not need to call StartListeningForEvents
/// for this broadcaster (that would fail anyway since the event bits
/// would most likely be taken by the listener(s) you are usurping.

8
lldb/include/lldb/Utility/CompletionRequest.h
View File

@ -160,8 +160,8 @@ public:
/// the suggested completion is stored, so the given string can be free'd
/// afterwards.
///
/// \param match The suggested completion.
/// \param completion An optional description of the completion string. The
/// \param completion The suggested completion.
/// \param description An optional description of the completion string. The
/// description will be displayed to the user alongside the completion.
/// \param mode The CompletionMode for this completion.
void AddCompletion(llvm::StringRef completion,
@ -173,7 +173,7 @@ public:
/// Adds a possible completion string if the completion would complete the
/// current argument.
///
/// \param match The suggested completion.
/// \param completion The suggested completion.
/// \param description An optional description of the completion string. The
/// description will be displayed to the user alongside the completion.
template <CompletionMode M = CompletionMode::Normal>
@ -203,7 +203,7 @@ public:
/// The number of completions and descriptions must be identical.
///
/// \param completions The list of completions.
/// \param completions The list of descriptions.
/// \param descriptions The list of descriptions.
///
/// \see AddCompletion
void AddCompletions(const StringList &completions,

2
lldb/include/lldb/Utility/Flags.h
View File

@ -29,7 +29,7 @@ public:
/// Constructs this object with \a mask as the initial value for all of the
/// flags.
///
/// \param[in] mask
/// \param[in] flags
/// The initial value for all flags.
Flags(ValueType flags = 0) : m_flags(flags) {}

4
lldb/source/Plugins/ExpressionParser/Clang/IRDynamicChecks.cpp
View File

@ -181,8 +181,8 @@ protected:
///
/// \param[in] inst
/// The instruction to be instrumented.
void RegisterInstruction(llvm::Instruction &i) {
m_to_instrument.push_back(&i);
void RegisterInstruction(llvm::Instruction &inst) {
m_to_instrument.push_back(&inst);
}
/// Determine whether a single instruction is interesting to instrument,