| Issue |
185193
|
| Summary |
Broken Doxygen API link for `clang::format::FormatStyle` in ClangFormatStyleOptions documentation
|
| Labels |
clang
|
| Assignees |
|
| Reporter |
KaganCanSit
|
The following paragraph in `clang/docs/ClangFormatStyleOptions.rst` contains a Doxygen API link that returns HTTP 404:
> When using ``clang::format::reformat(...)`` functions, the format is specified by supplying the `clang::format::FormatStyle <https://clang.llvm.org/doxygen/structclang_1_1format_1_1FormatStyle.html>`_ structure.
Referring Page: https://clang.llvm.org/docs/ClangFormatStyleOptions.html
Section: **Configuring Style in Code**
## Steps to reproduce
1. Visit https://clang.llvm.org/docs/ClangFormatStyleOptions.html
2. Click the `clang::format::FormatStyle` link in **Configuring Style in Code**
3. Observe HTTP 404
## Expected behavior
The URL resolves to the Doxygen documentation for `struct FormatStyle`, defined in `clang/include/clang/Format/Format.h`:
```cpp
namespace clang {
namespace format {
struct FormatStyle { ... };
} // namespace format
} // namespace clang
```
## More Info
A local Doxygen build correctly generates `structclang_1_1format_1_1FormatStyle.html`. The file is present in the local build output. The broken link is therefore caused by an incomplete or stale deployment on `clang.llvm.org/doxygen/`.
### Local verification
```bash
mkdir -p build && cd build
cmake -G Ninja ../llvm -DLLVM_ENABLE_PROJECTS=clang -DLLVM_ENABLE_DOXYGEN=ON ninja doxygen-clang
xdg-open tools/clang/docs/doxygen/html/structclang_1_1format_1_1FormatStyle.html
```
Since I haven't contributed to the project before and am not familiar with the doxygen/deploy process, I wanted to share my preliminary findings.
If there's anything I can help with, please leave a comment.
Regards.
![]()
_______________________________________________
llvm-bugs mailing list
[email protected]
https://lists.llvm.org/cgi-bin/mailman/listinfo/llvm-bugs
