[all-commits] [llvm/llvm-project] b0322a: [docs] Fix doxygen comments wrongly attached to th...

Nicolás Alvarez via All-commits all-commits at lists.llvm.org
Tue Apr 20 10:50:37 PDT 2021


  Branch: refs/heads/main
  Home:   https://github.com/llvm/llvm-project
  Commit: b0322a4ed2b2d5a5b3b0ea2ef4da40606f6838d1
      https://github.com/llvm/llvm-project/commit/b0322a4ed2b2d5a5b3b0ea2ef4da40606f6838d1
  Author: Nicolás Alvarez <nicolas.alvarez at gmail.com>
  Date:   2021-04-20 (Tue, 20 Apr 2021)

  Changed paths:
    M clang/include/clang/AST/ExternalASTSource.h
    M clang/include/clang/Analysis/FlowSensitive/DataflowValues.h
    M clang/include/clang/StaticAnalyzer/Core/PathSensitive/LoopUnrolling.h
    M clang/include/clang/StaticAnalyzer/Core/PathSensitive/LoopWidening.h

  Log Message:
  -----------
  [docs] Fix doxygen comments wrongly attached to the clang namespace

Looking at the Doxygen-generated documentation for the clang namespace
currently shows several random comments from different parts of the
codebase. These are caused by:

- File doc comments that aren't marked with \file, so they're attached to
  the next declaration, which is usually "namespace clang {".
- Class doc comments placed before the namespace rather than before the
  class.

This commit fixes these comments. The generated doxygen documentation now
has proper docs for several classes and files, and the docs for the clang
namespace is now empty.

Differential Revision: https://reviews.llvm.org/D96738




More information about the All-commits mailing list