@@ -28,67 +28,87 @@ class LLDB_API SBSaveCoreOptions {
2828 // / Set the plugin name. Supplying null or empty string will reset
2929 // / the option.
3030 // /
31- // / \param plugin Name of the object file plugin.
31+ // / \param plugin
32+ // / Name of the object file plugin.
3233 SBError SetPluginName (const char *plugin);
3334
3435 // / Get the Core dump plugin name, if set.
3536 // /
36- // / \return The name of the plugin, or null if not set.
37+ // / \return
38+ // / The name of the plugin, or null if not set.
3739 const char *GetPluginName () const ;
3840
3941 // / Set the Core dump style.
4042 // /
41- // / \param style The style of the core dump.
43+ // / \param style
44+ // / The style of the core dump.
4245 void SetStyle (lldb::SaveCoreStyle style);
4346
4447 // / Get the Core dump style, if set.
4548 // /
46- // / \return The core dump style, or undefined if not set.
49+ // / \return
50+ // / The core dump style, or undefined if not set.
4751 lldb::SaveCoreStyle GetStyle () const ;
4852
4953 // / Set the output file path
5054 // /
51- // / \param output_file a
52- // / \class SBFileSpec object that describes the output file.
55+ // / \param
56+ // / output_file a \class SBFileSpec object that describes the output file.
5357 void SetOutputFile (SBFileSpec output_file);
5458
5559 // / Get the output file spec
5660 // /
57- // / \return The output file spec.
61+ // / \return
62+ // / The output file spec.
5863 SBFileSpec GetOutputFile () const ;
5964
6065 // / Set the process to save, or unset if supplied with a default constructed
6166 // / process.
6267 // /
63- // / \param process The process to save.
64- // / \return Success if process was set, otherwise an error
65- // / \note This will clear all process specific options if a different process
66- // / is specified than the current set process, either explicitly from this
67- // / api, or implicitly from any function that requires a process.
68+ // / \param process
69+ // / The process to save.
70+ // /
71+ // / \return
72+ // / Success if process was set, otherwise an error
73+ // /
74+ // / \note
75+ // / This will clear all process specific options if a different process
76+ // / is specified than the current set process, either explicitly from this
77+ // / api, or implicitly from any function that requires a process.
6878 SBError SetProcess (lldb::SBProcess process);
6979
7080 // / Add a thread to save in the core file.
7181 // /
72- // / \param thread The thread to save.
73- // / \note This will set the process if it is not already set, or return
74- // / and error if the SBThread is not from the set process.
82+ // / \param thread
83+ // / The thread to save.
84+ // /
85+ // / \note
86+ // / This will set the process if it is not already set, or return
87+ // / and error if the SBThread is not from the set process.
7588 SBError AddThread (lldb::SBThread thread);
7689
7790 // / Remove a thread from the list of threads to save.
7891 // /
79- // / \param thread The thread to remove.
80- // / \return True if the thread was removed, false if it was not in the list.
92+ // / \param thread
93+ // / The thread to remove.
94+ // /
95+ // / \return
96+ // / True if the thread was removed, false if it was not in the list.
8197 bool RemoveThread (lldb::SBThread thread);
8298
8399 // / Add a memory region to save in the core file.
84100 // /
85- // / \param region The memory region to save.
86- // / \returns An empty SBError upon success, or an error if the region is
87- // / invalid.
88- // / \note Ranges that overlapped will be unioned into a single region, this
89- // / also supercedes stack minification. Specifying full regions and a
90- // / non-custom core style will include the specified regions and union them
91- // / with all style specific regions.
101+ // / \param region
102+ // / The memory region to save.
103+ // /
104+ // / \returns
105+ // / An empty SBError upon success, or an error if the region is invalid.
106+ // /
107+ // / \note
108+ // / Ranges that overlapped will be unioned into a single region, this also
109+ // / supercedes stack minification. Specifying full regions and a non-custom
110+ // / core style will include the specified regions and union them with all
111+ // / style specific regions.
92112 SBError AddMemoryRegionToSave (const SBMemoryRegionInfo ®ion);
93113
94114 // / Reset all options.
0 commit comments