[all-commits] [llvm/llvm-project] a3e2b6: [clangd] extend and rearrange doxygen hover docume...

[tcottin via All-commits]

  Branch: refs/heads/main
  Home:   https://github.com/llvm/llvm-project
  Commit: a3e2b64b0ddf42abf065377d77a9957edd142585
      https://github.com/llvm/llvm-project/commit/a3e2b64b0ddf42abf065377d77a9957edd142585
  Author: tcottin <timcottin at gmx.de>
  Date:   2025-08-25 (Mon, 25 Aug 2025)

  Changed paths:
    M clang-tools-extra/clangd/CodeComplete.cpp
    M clang-tools-extra/clangd/CodeCompletionStrings.cpp
    M clang-tools-extra/clangd/Hover.cpp
    M clang-tools-extra/clangd/Protocol.cpp
    M clang-tools-extra/clangd/Quality.cpp
    M clang-tools-extra/clangd/SymbolDocumentation.cpp
    M clang-tools-extra/clangd/SymbolDocumentation.h
    M clang-tools-extra/clangd/unittests/HoverTests.cpp
    M clang-tools-extra/clangd/unittests/SymbolDocumentationTests.cpp
    M clang/include/clang/Index/IndexSymbol.h
    M clang/lib/Index/IndexSymbol.cpp

  Log Message:
  -----------
  [clangd] extend and rearrange doxygen hover documentation (#152918)

This is the final patch to solve clangd/clangd#529.

This uses the patches from
[llvm/llvm-project#140498](https://github.com/llvm/llvm-project/pull/140498)
and
[llvm/llvm-project#150790](https://github.com/llvm/llvm-project/pull/150790)
to improve the hover content for doxygen documented code.

The patch uses the information from the parsed doxygen comment to extend
and rearrange the hover documentation:
- own section for brief, notes and warning documentation
- for functions add parameter/template parameter documentation
- for functions add return documentation

Note: this requires to configure

```yaml
Documentation:
  CommentFormat: Doxygen
```

in your `.clangd` configuration.

---------

Co-authored-by: Maksim Ivanov <emaxx at google.com>



To unsubscribe from these emails, change your notification settings at https://github.com/llvm/llvm-project/settings/notifications