llvm / llvm/llvm-project

Broken Doxygen API link for `clang::format::FormatStyle` in ClangFormatStyleOptions documentation

Open
#185,193 2 comments 0 reactions 0 assignees View on GitHub
clang clang-format documentation
Dominant language
LLVM
Stars
40.5k
Forks
18.7k
PR merge metrics
PR metrics pending

Description

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 `_ 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.

### 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.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.