[clang-tools-extra] [clang-doc] Allow setting a base directory for hosted pages (PR #132482)

Fri Mar 21 15:47:57 PDT 2025

github-actions[bot] wrote:




:warning: C/C++ code formatter, clang-format found issues in your code. :warning:

<details>
<summary>
You can test this locally with the following command:
</summary>

``````````bash
git-clang-format --diff 052a4b54a75364f13ea5001bba00691da4d8c239 953bbddc9baa63e8d7649026b08a6cbbbcdeec31 --extensions h,cpp -- clang-tools-extra/clang-doc/HTMLGenerator.cpp clang-tools-extra/clang-doc/Representation.cpp clang-tools-extra/clang-doc/Representation.h clang-tools-extra/clang-doc/tool/ClangDocMain.cpp clang-tools-extra/test/clang-doc/assets.cpp clang-tools-extra/test/clang-doc/test-path-abs.cpp clang-tools-extra/unittests/clang-doc/HTMLGeneratorTest.cpp
``````````

</details>

<details>
<summary>
View the diff from clang-format here.
</summary>

``````````diff

diff --git a/clang-tools-extra/clang-doc/Representation.h b/clang-tools-extra/clang-doc/Representation.h
index 562b8938b7..b614ce45f5 100644
--- a/clang-tools-extra/clang-doc/Representation.h
+++ b/clang-tools-extra/clang-doc/Representation.h
@@ -507,8 +507,7 @@ struct ClangDocContext {
   ClangDocContext() = default;
   ClangDocContext(tooling::ExecutionContext *ECtx, StringRef ProjectName,
                   bool PublicOnly, StringRef OutDirectory, StringRef SourceRoot,
-                  StringRef RepositoryUrl,
-                  StringRef Base,
+                  StringRef RepositoryUrl, StringRef Base,
                   std::vector<std::string> UserStylesheets);
   tooling::ExecutionContext *ECtx;
   std::string ProjectName; // Name of project clang-doc is documenting.
diff --git a/clang-tools-extra/clang-doc/tool/ClangDocMain.cpp b/clang-tools-extra/clang-doc/tool/ClangDocMain.cpp
index fc5962b3b6..868d9a442e 100644
--- a/clang-tools-extra/clang-doc/tool/ClangDocMain.cpp
+++ b/clang-tools-extra/clang-doc/tool/ClangDocMain.cpp
@@ -69,9 +69,8 @@ static llvm::cl::opt<std::string>
 
 static llvm::cl::opt<std::string>
     BaseDirectory("base",
-                 llvm::cl::desc("Base Directory for generated documentation."),
-                 llvm::cl::init(""), llvm::cl::cat(ClangDocCategory));
-
+                  llvm::cl::desc("Base Directory for generated documentation."),
+                  llvm::cl::init(""), llvm::cl::cat(ClangDocCategory));
 
 static llvm::cl::opt<bool>
     PublicOnly("public", llvm::cl::desc("Document only public declarations."),
@@ -275,8 +274,7 @@ Example usage for a project using a compile commands database:
       SourceRoot,
       RepositoryUrl,
       BaseDirectory,
-      {UserStylesheets.begin(), UserStylesheets.end()}
-  };
+      {UserStylesheets.begin(), UserStylesheets.end()}};
 
   if (Format == "html") {
     if (auto Err = getHtmlAssetFiles(argv[0], CDCtx)) {
diff --git a/clang-tools-extra/unittests/clang-doc/HTMLGeneratorTest.cpp b/clang-tools-extra/unittests/clang-doc/HTMLGeneratorTest.cpp
index 64363923ad..66cf77d7b0 100644
--- a/clang-tools-extra/unittests/clang-doc/HTMLGeneratorTest.cpp
+++ b/clang-tools-extra/unittests/clang-doc/HTMLGeneratorTest.cpp
@@ -299,8 +299,7 @@ TEST(HTMLGeneratorTest, emitFunctionHTML) {
   assert(G);
   std::string Buffer;
   llvm::raw_string_ostream Actual(Buffer);
-  ClangDocContext CDCtx =
-      getClangDocContext({}, "https://www.repository.com");
+  ClangDocContext CDCtx = getClangDocContext({}, "https://www.repository.com");
   auto Err = G->generateDocForInfo(&I, Actual, CDCtx);
   assert(!Err);
   std::string Expected = R"raw(<!DOCTYPE html>

``````````

</details>


https://github.com/llvm/llvm-project/pull/132482
