llvm-project/clang
Alp Toker 59c6bc5882 libclang: split out the documentation comment API
It's possible that the "comment AST" may be replaced or split out in the
midterm, any anyway this makes the headers easier to read.

Developers don't currently need to include "clang-c/Documentation.h" explicitly
and there's no macro to test for availability yet.

The raw comment and brief comment accessors have been kept in Index.h though
brief support may also move here as a separate proposal.

This is not a deprecation, just a gentle separation of concerns as we look to
simplify the built-in representation of comment nodes and support external
comment processors.

llvm-svn: 207392
2014-04-28 02:39:27 +00:00
..
INPUTS
bindings Fix the method len of the CompletionString object. Patch by Christopher Greene 2014-04-27 04:42:55 +00:00
docs Review feedback. 2014-04-23 15:21:23 +00:00
examples Fix build break, replace take() with release(). 2014-03-09 11:46:32 +00:00
include libclang: split out the documentation comment API 2014-04-28 02:39:27 +00:00
lib [objcmt] Revert r191796, it's not needed anymore. 2014-04-28 02:38:51 +00:00
runtime [CMake] Propagate top-level targets for compiler-rt runtimes and test-suites 2014-03-21 13:09:25 +00:00
test [SemaCXX] Silence -Wconstant-logical-operand if the operand is a 0/1 from a macro. 2014-04-28 00:20:16 +00:00
tools libclang: split out the documentation comment API 2014-04-28 02:39:27 +00:00
unittests clang-format: Fix bug when aligning trailing /**/-comments in macros. 2014-04-27 10:03:19 +00:00
utils Comment parsing: in the generated XML file, mark HTML that is safe to pass 2014-04-22 10:59:13 +00:00
www remove less relevant information + about packaging/Mac OS X + link to cfe-dev 2014-04-27 15:17:15 +00:00
.arcconfig Updated phabricator server. 2014-04-07 03:39:55 +00:00
.clang-format
.gitignore
CMakeLists.txt We now require Visual C++ 2012 (MSVC_VERSION = 1700) or later to build LLVM. 2014-03-04 09:12:17 +00:00
CODE_OWNERS.TXT Adding myself as the code owner for the attribute subsystem. 2014-01-13 22:23:27 +00:00
INSTALL.txt
LICENSE.TXT Update the copyright credits -- Happy new year 2014! 2014-01-01 08:27:31 +00:00
Makefile Define ENABLE_CLANG_EXAMPLES instead of relying on BUILD_EXAMPLES 2014-01-08 13:00:32 +00:00
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.cs.uiuc.edu/mailman/listinfo/cfe-dev

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