llvm-project/clang
Ekaterina Romanova ea8702d393 [DOXYGEN] Minor improvements in doxygen comments.
- I removed doxygen comments for the intrinsics that "alias" the other existing documented intrinsics and that only sligtly differ in spelling (single underscores vs. double underscores). 
 #define _tzcnt_u16(a)     (__tzcnt_u16((a)))

It will be very hard to keep the documentation for these "aliases" in sync with the documentation for the intrinsics they alias to. Out of sync documentation will be more confusing than no documentation.

I got an OK from Eric Christopher to commit doxygen comments without prior code
review upstream.

llvm-svn: 301652
2017-04-28 16:45:39 +00:00
..
INPUTS
bindings Add Python 3 support to clang.cindex 2017-04-20 10:11:01 +00:00
cmake [CMake] Enable ARM target in Fuchsia toolchain 2017-04-20 23:06:53 +00:00
docs [Docs] Correct the path to the clang-format-diff.py script to include the clang-format directory. 2017-04-24 17:39:35 +00:00
examples Add LLVMOption to clang-interpreter, corresponding to r291938. 2017-01-14 08:54:05 +00:00
include [libclang] Expose some target information via the C API. 2017-04-28 15:56:39 +00:00
lib [DOXYGEN] Minor improvements in doxygen comments. 2017-04-28 16:45:39 +00:00
runtime [sanitizer] Passthrough CMAKE_OSX_DEPLOYMENT_TARGET and CMAKE_OSX_SYSROOT when building compiler-rt from clang/runtime/CMakeLists.txt 2016-12-15 23:20:54 +00:00
test [libclang] Expose some target information via the C API. 2017-04-28 15:56:39 +00:00
tools [libclang] Expose some target information via the C API. 2017-04-28 15:56:39 +00:00
unittests clang-format: [JS] parse async function declarations. 2017-04-27 13:07:24 +00:00
utils Add #pragma clang attribute support to the external_source_symbol attribute 2017-04-19 15:52:11 +00:00
www Implement DR 373 "Lookup on namespace qualified name in using-directive" 2017-03-17 21:41:20 +00:00
.arcconfig
.clang-format
.clang-tidy
.gitignore
CMakeLists.txt [analyzer] Add new Z3 constraint manager backend 2017-04-04 19:52:25 +00:00
CODE_OWNERS.TXT
INSTALL.txt
LICENSE.TXT
ModuleInfo.txt
NOTES.txt
README.txt

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/