llvm-project/clang
Adrian Prantl 9fc8faf9e6 Remove \brief commands from doxygen comments.
This is similar to the LLVM change https://reviews.llvm.org/D46290.

We've been running doxygen with the autobrief option for a couple of
years now. This makes the \brief markers into our comments
redundant. Since they are a visual distraction and we don't want to
encourage more \brief markers in new code either, this patch removes
them all.

Patch produced by

for i in $(git grep -l '\@brief'); do perl -pi -e 's/\@brief //g' $i & done
for i in $(git grep -l '\\brief'); do perl -pi -e 's/\\brief //g' $i & done

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

llvm-svn: 331834
2018-05-09 01:00:01 +00:00
..
INPUTS
bindings [python bindings] Fix Cursor.result_type for ObjC method declarations - Bug 36677 2018-04-22 20:51:05 +00:00
cmake Set CMAKE_BUILD_WITH_INSTALL_RPATH for Fuchsia runtimes 2018-05-09 00:58:12 +00:00
docs Remove \brief commands from doxygen comments. 2018-05-09 01:00:01 +00:00
examples s/LLVM_ON_WIN32/_WIN32/, clang 2018-04-27 19:11:14 +00:00
include Remove \brief commands from doxygen comments. 2018-05-09 01:00:01 +00:00
lib Remove \brief commands from doxygen comments. 2018-05-09 01:00:01 +00:00
runtime [clang] Use add_llvm_install_targets 2017-11-30 22:35:02 +00:00
test Fix float->int conversion warnings when near barriers. 2018-05-08 21:26:21 +00:00
tools Remove \brief commands from doxygen comments. 2018-05-09 01:00:01 +00:00
unittests [ASTMatchers] Overload isConstexpr for ifStmts 2018-05-08 11:53:32 +00:00
utils Remove \brief commands from doxygen comments. 2018-05-09 01:00:01 +00:00
www Fix typos in clang 2018-04-06 15:14:32 +00:00
.arcconfig [clang] Set up .arcconfig to point to new Diffusion C repository 2017-11-27 17:21:24 +00:00
.clang-format
.clang-tidy Backport changes from llvm/.clang_tidy to clang/.clang_tidy configs 2018-03-20 14:39:12 +00:00
.gitignore
CMakeLists.txt CMake option to allow enabling experimental new pass manager by default 2018-04-06 00:53:00 +00:00
CODE_OWNERS.TXT Change code owner for Clang Static Analyzer to Devin Coughlin. 2017-11-17 23:19:04 +00:00
INSTALL.txt
LICENSE.TXT
ModuleInfo.txt
NOTES.txt
README.txt Test commit 2017-10-21 16:03:17 +00:00

README.txt

//===----------------------------------------------------------------------===//
// C Language Family Front-end
//===----------------------------------------------------------------------===//

Welcome to Clang.  This is a compiler front-end for the C family of languages
(C, C++, Objective-C, and Objective-C++) which is built as part of the LLVM
compiler infrastructure project.

Unlike many other compiler frontends, Clang is useful for a number of things
beyond just compiling code: we intend for Clang to be host to a number of
different source-level tools.  One example of this is the Clang Static Analyzer.

If you're interested in more (including how to build Clang) it is best to read
the relevant web sites.  Here are some pointers:

Information on Clang:             http://clang.llvm.org/
Building and using Clang:         http://clang.llvm.org/get_started.html
Clang Static Analyzer:            http://clang-analyzer.llvm.org/
Information on the LLVM project:  http://llvm.org/

If you have questions or comments about Clang, a great place to discuss them is
on the Clang development mailing list:
  http://lists.llvm.org/mailman/listinfo/cfe-dev

If you find a bug in Clang, please file it in the LLVM bug tracker:
  http://llvm.org/bugs/