Add docs and conform to the existing code style (capitalize variable names).

Author: vsapsai

clang/include/clang-c/Dependencies.h

@@ -325,10 +325,29 @@ CINDEX_LINKAGE void
     clang_experimental_DependencyScannerWorkerScanSettings_dispose(
         CXDependencyScannerWorkerScanSettings);
 
+/**
+ * Generates a reproducer to compile a requested file with required modules.
+ *
+ * Here the reproducer means the required input data with the commands to
+ * compile intermediate modules and a requested file. Required intermediate
+ * modules and the order of their compilation are determined by the function
+ * and don't need to be provided.
+ *
+ * \param argc the number of compiler invocation arguments (including argv[0]).
+ * \param argv the compiler driver invocation arguments (including argv[0]).
+ * \param WorkingDirectory the directory in which the invocation runs.
+ * \param [out] MessageOut A pointer to store the human-readable message
+ *                         describing the result of the operation. If non-NULL,
+ *                         owned and should be disposed by the caller.
+ *
+ * \returns \c CXError_Success on success; otherwise a non-zero \c CXErrorCode
+ * indicating the kind of error. \p MessageOut is guaranteed to be populated
+ * for a success case but is allowed to be empty when encountered an error.
+ */
 CINDEX_LINKAGE enum CXErrorCode
 clang_experimental_DependencyScanner_generateReproducer(
     int argc, const char *const *argv, const char *WorkingDirectory,
-    CXString *messageOut);
+    CXString *MessageOut);
 
 /**
  * Produces the dependency graph for a particular compiler invocation.

clang/tools/libclang/CDependencies.cpp

@@ -345,18 +345,18 @@ class MessageEmitter {
 
 enum CXErrorCode clang_experimental_DependencyScanner_generateReproducer(
     int argc, const char *const *argv, const char *WorkingDirectory,
-    CXString *messageOut) {
-  auto report = [messageOut](CXErrorCode errorCode) -> MessageEmitter {
-    return MessageEmitter(errorCode, messageOut);
+    CXString *MessageOut) {
+  auto Report = [MessageOut](CXErrorCode ErrorCode) -> MessageEmitter {
+    return MessageEmitter(ErrorCode, MessageOut);
   };
-  auto reportFailure = [&report]() -> MessageEmitter {
-    return report(CXError_Failure);
+  auto ReportFailure = [&Report]() -> MessageEmitter {
+    return Report(CXError_Failure);
   };
 
   if (argc < 2 || !argv)
-    return report(CXError_InvalidArguments) << "missing compilation command";
+    return Report(CXError_InvalidArguments) << "missing compilation command";
   if (!WorkingDirectory)
-    return report(CXError_InvalidArguments) << "missing working directory";
+    return Report(CXError_InvalidArguments) << "missing working directory";
 
   CASOptions CASOpts;
   IntrusiveRefCntPtr<llvm::cas::CachingOnDiskFileSystem> FS;
@@ -369,7 +369,7 @@ enum CXErrorCode clang_experimental_DependencyScanner_generateReproducer(
   int ScriptFD;
   if (auto EC = llvm::sys::fs::createTemporaryFile("reproducer", "sh", ScriptFD,
                                                    ReproScriptPath)) {
-    return reportFailure() << "failed to create a reproducer script file";
+    return ReportFailure() << "failed to create a reproducer script file";
   }
   SmallString<128> FileCachePath = ReproScriptPath;
   llvm::sys::path::replace_extension(FileCachePath, ".cache");
@@ -388,15 +388,14 @@ enum CXErrorCode clang_experimental_DependencyScanner_generateReproducer(
   auto TUDepsOrErr = DepsTool.getTranslationUnitDependencies(
       Compilation, WorkingDirectory, AlreadySeen, std::move(LookupOutput));
   if (!TUDepsOrErr)
-    return reportFailure() << "failed to generate a reproducer\n"
+    return ReportFailure() << "failed to generate a reproducer\n"
                            << toString(TUDepsOrErr.takeError());
 
   TranslationUnitDeps TU = *TUDepsOrErr;
   llvm::raw_fd_ostream ScriptOS(ScriptFD, /*shouldClose=*/true);
   ScriptOS << "# Original command:\n#";
-  for (StringRef cliArg : Compilation) {
-    ScriptOS << ' ' << cliArg;
-  }
+  for (StringRef Arg : Compilation)
+    ScriptOS << ' ' << Arg;
   ScriptOS << "\n\n";
 
   ScriptOS << "# Dependencies:\n";
@@ -410,34 +409,34 @@ enum CXErrorCode clang_experimental_DependencyScanner_generateReproducer(
     OS << " -ivfsoverlay \"" << FileCacheName << "/vfs/vfs.yaml\"";
     OS << '\n';
   };
-  for (ModuleDeps &dep : TU.ModuleGraph)
-    PrintArguments(ScriptOS, dep.getBuildArguments());
+  for (ModuleDeps &Dep : TU.ModuleGraph)
+    PrintArguments(ScriptOS, Dep.getBuildArguments());
   ScriptOS << "\n# Translation unit:\n";
-  for (const Command &buildCommand : TU.Commands)
-    PrintArguments(ScriptOS, buildCommand.Arguments);
+  for (const Command &BuildCommand : TU.Commands)
+    PrintArguments(ScriptOS, BuildCommand.Arguments);
 
   SmallString<128> VFSCachePath = FileCachePath;
   llvm::sys::path::append(VFSCachePath, "vfs");
   std::string VFSCachePathStr = VFSCachePath.str().str();
-  llvm::FileCollector fileCollector(VFSCachePathStr,
+  llvm::FileCollector FileCollector(VFSCachePathStr,
                                     /*OverlayRoot=*/VFSCachePathStr);
-  for (const auto &fileDep : TU.FileDeps) {
-    fileCollector.addFile(fileDep);
+  for (const auto &FileDep : TU.FileDeps) {
+    FileCollector.addFile(FileDep);
   }
-  for (ModuleDeps &dep : TU.ModuleGraph) {
-    dep.forEachFileDep([&fileCollector](StringRef fileDep) {
-      fileCollector.addFile(fileDep);
+  for (ModuleDeps &ModuleDep : TU.ModuleGraph) {
+    ModuleDep.forEachFileDep([&FileCollector](StringRef FileDep) {
+      FileCollector.addFile(FileDep);
     });
   }
-  if (fileCollector.copyFiles(/*StopOnError=*/true))
-    return reportFailure()
+  if (FileCollector.copyFiles(/*StopOnError=*/true))
+    return ReportFailure()
            << "failed to copy the files used for the compilation";
   SmallString<128> VFSOverlayPath = VFSCachePath;
   llvm::sys::path::append(VFSOverlayPath, "vfs.yaml");
-  if (fileCollector.writeMapping(VFSOverlayPath))
-    return reportFailure() << "failed to write a VFS overlay mapping";
+  if (FileCollector.writeMapping(VFSOverlayPath))
+    return ReportFailure() << "failed to write a VFS overlay mapping";
 
-  return report(CXError_Success)
+  return Report(CXError_Success)
          << "Created a reproducer. Sources and associated run script(s) are "
             "located at:\n  "
          << FileCachePath << "\n  " << ReproScriptPath;