Skip to content

Commit d1af3ae

Browse files
committed
Add some docs.
1 parent d831b09 commit d1af3ae

File tree

2 files changed

+12
-0
lines changed

2 files changed

+12
-0
lines changed

Sources/SWBCSupport/CLibclang.cpp

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -859,6 +859,9 @@ extern "C" {
859859
typedef struct CXOpaqueDependencyScannerServiceOptions
860860
*CXDependencyScannerServiceOptions;
861861

862+
/**
863+
* Generate a self-contained reproducer in a specified location to re-run the compilation.
864+
*/
862865
enum CXErrorCode
863866
(*clang_experimental_DependencyScanner_generateReproducer)(
864867
int argc, const char *const *argv, const char *WorkingDirectory,

Sources/SWBCSupport/CLibclang.h

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -128,6 +128,7 @@ CSUPPORT_EXPORT bool libclang_has_cas_up_to_date_checks_feature(libclang_t lib);
128128
/// Whether the libclang has current working directory optimization support.
129129
CSUPPORT_EXPORT bool libclang_has_current_working_directory_optimization(libclang_t lib);
130130

131+
/// Whether the libclang has reproducer generation support.
131132
bool libclang_has_reproducer_feature(libclang_t lib);
132133

133134
/// Create the CAS options object.
@@ -205,6 +206,14 @@ CSUPPORT_EXPORT bool libclang_scanner_scan_dependencies(
205206
void (^diagnostics_callback)(const libclang_diagnostic_set_t),
206207
void (^error_callback)(const char *));
207208

209+
/// Generate a way to re-run the compilation without all the source files and the build system.
210+
///
211+
/// \param scanner - The scanner to use.
212+
/// \param argc - The number of arguments.
213+
/// \param argv - The Clang driver command line (including a program name in argv[0]).
214+
/// \param workingDirectory - The working directory to use for evaluation.
215+
/// \param message[out] - The human-readable message describing the result of the operation.
216+
/// \returns True on success, false if something failed (see \p message for more details).
208217
bool libclang_scanner_generate_reproducer(
209218
libclang_scanner_t scanner, int argc, char *const *argv, const char *workingDirectory,
210219
const char **message);

0 commit comments

Comments
 (0)