llvm-capstone/clang
Richard Smith 09ac4a1bc9 Improve attribute documentation to list which spellings are used in which syntaxes.
Summary:
Instead of listing all the spellings (including attribute namespaces) in
the section heading, only list the actual attribute names there, and
list the spellings in the supported syntaxes table.

This allows us to properly describe things like [[fallthrough]], for
which we allow a clang:: prefix in C++ but not in C, and AlwaysInline,
which has one spelling as a GNU attribute and a different spelling as a
keyword, without needing to repeat the syntax description in the
documentation text.

Sample rendering: https://pste.eu/p/T1ZV.html

Reviewers: aaron.ballman

Subscribers: cfe-commits

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

llvm-svn: 341097
2018-08-30 19:16:33 +00:00
..
bindings
cmake [CMake] Link static libunwind and libc++abi into libc++ in Fuchsia toolchain 2018-07-25 01:44:22 +00:00
docs [docs] Regenerate ClangCommandLineReference.rst 2018-08-23 17:55:03 +00:00
examples
include Improve attribute documentation to list which spellings are used in which syntaxes. 2018-08-30 19:16:33 +00:00
INPUTS
lib [OPENMP] Fix PR38710: static functions are not emitted as implicitly 2018-08-30 18:56:11 +00:00
runtime
test [OPENMP] Fix PR38710: static functions are not emitted as implicitly 2018-08-30 18:56:11 +00:00
tools [CodeComplete] Report location of opening parens for signature help 2018-08-30 13:08:03 +00:00
unittests Parse compile commands lazily in InterpolatingCompilationDatabase 2018-08-28 16:15:56 +00:00
utils Improve attribute documentation to list which spellings are used in which syntaxes. 2018-08-30 19:16:33 +00:00
www [analyzer][UninitializedObjectChecker] Added documentation to the checker list 2018-08-21 10:47:19 +00:00
.arcconfig
.clang-format
.clang-tidy
.gitignore [NFC] Add tags file to .gitignore 2018-08-22 23:23:17 +00:00
CMakeLists.txt libclang: add install/distribution targets for python 2018-08-20 22:50:18 +00:00
CODE_OWNERS.TXT
INSTALL.txt
LICENSE.TXT
ModuleInfo.txt
NOTES.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/