@@ -28,67 +28,87 @@ class LLDB_API SBSaveCoreOptions {
28
28
// / Set the plugin name. Supplying null or empty string will reset
29
29
// / the option.
30
30
// /
31
- // / \param plugin Name of the object file plugin.
31
+ // / \param plugin
32
+ // / Name of the object file plugin.
32
33
SBError SetPluginName (const char *plugin);
33
34
34
35
// / Get the Core dump plugin name, if set.
35
36
// /
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.
37
39
const char *GetPluginName () const ;
38
40
39
41
// / Set the Core dump style.
40
42
// /
41
- // / \param style The style of the core dump.
43
+ // / \param style
44
+ // / The style of the core dump.
42
45
void SetStyle (lldb::SaveCoreStyle style);
43
46
44
47
// / Get the Core dump style, if set.
45
48
// /
46
- // / \return The core dump style, or undefined if not set.
49
+ // / \return
50
+ // / The core dump style, or undefined if not set.
47
51
lldb::SaveCoreStyle GetStyle () const ;
48
52
49
53
// / Set the output file path
50
54
// /
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.
53
57
void SetOutputFile (SBFileSpec output_file);
54
58
55
59
// / Get the output file spec
56
60
// /
57
- // / \return The output file spec.
61
+ // / \return
62
+ // / The output file spec.
58
63
SBFileSpec GetOutputFile () const ;
59
64
60
65
// / Set the process to save, or unset if supplied with a default constructed
61
66
// / process.
62
67
// /
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.
68
78
SBError SetProcess (lldb::SBProcess process);
69
79
70
80
// / Add a thread to save in the core file.
71
81
// /
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.
75
88
SBError AddThread (lldb::SBThread thread);
76
89
77
90
// / Remove a thread from the list of threads to save.
78
91
// /
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.
81
97
bool RemoveThread (lldb::SBThread thread);
82
98
83
99
// / Add a memory region to save in the core file.
84
100
// /
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.
92
112
SBError AddMemoryRegionToSave (const SBMemoryRegionInfo ®ion);
93
113
94
114
// / Reset all options.
0 commit comments