[clang] 5259ff7 - Reword the open project for generating documentation

Aaron Ballman via cfe-commits cfe-commits at lists.llvm.org
Mon Apr 24 08:55:54 PDT 2023


Author: Aaron Ballman
Date: 2023-04-24T11:55:11-04:00
New Revision: 5259ff7f0aef9aa1871e623608d5c00d3284adb0

URL: https://github.com/llvm/llvm-project/commit/5259ff7f0aef9aa1871e623608d5c00d3284adb0
DIFF: https://github.com/llvm/llvm-project/commit/5259ff7f0aef9aa1871e623608d5c00d3284adb0.diff

LOG: Reword the open project for generating documentation

Work already began on this project, so this updates the wording to
discuss clang-doc specifically.

Added: 
    

Modified: 
    clang/www/OpenProjects.html

Removed: 
    


################################################################################
diff  --git a/clang/www/OpenProjects.html b/clang/www/OpenProjects.html
index 3d55099df869..c7cde4f2c040 100755
--- a/clang/www/OpenProjects.html
+++ b/clang/www/OpenProjects.html
@@ -88,14 +88,12 @@ <h1>Open Clang Projects</h1>
 performance as well as to find ways to proactively alert us when we've
 introduced a change that has significant negative impact on build times.</li>
 
-<li><b>Implement an tool to generate code documentation</b>: Clang's
-library-based design allows it to be used by a variety of tools that reason
-about source code. One great application of Clang would be to build an
-auto-documentation system like doxygen that generates code documentation from
-source code. The advantage of using Clang for such a tool is that the tool would
-use the same preprocessor/parser/ASTs as the compiler itself, giving it a very
-rich understanding of the code. Clang is already able to read and understand
-doxygen markup, but cannot yet generate documentation from it.</li>
+<li><b>Improve clang-doc</b>: Clang's library-based design allows it to be used
+by a variety of tools that reason about source code.
+<a href="https://clang.llvm.org/extra/clang-doc.html">clang-doc</a> is one
+great application of this functionality, which generates code documentation
+from source code. The tool is in early stages of development and could use more
+dedicated effort to complete the implementation.</li>
 
 <li><b>Use clang libraries to implement better versions of existing tools</b>:
 Clang is built as a set of libraries, which means that it is possible to


        


More information about the cfe-commits mailing list