llvm-project/libcxx/docs
Eric Fiselier 4959542657 Add documentation and tests for Clangs C++11 extensions in C++03.
As we gear up to drop support for GCC in C++03, we should make clear
what our C++03 mode is, the C++11 extensions it provides,
and the C++11 extensions it depends on.

The section of this document discussing user-facing extensions has
been left blank while the community discusses new directions. For now
it's just a warning to users.

Additionally, the document contains examples of how these extensions
should be used and why. For example, using alias templates over class
templates.

llvm-svn: 363110
2019-06-11 22:53:49 +00:00
..
DesignDocs Add documentation and tests for Clangs C++11 extensions in C++03. 2019-06-11 22:53:49 +00:00
BuildingLibcxx.rst [Docs] Modernize references to macOS 2019-05-30 16:46:22 +00:00
CMakeLists.txt docs: Fix Sphinx detection with out-of-tree builds 2017-05-09 11:18:03 +00:00
FeatureTestMacroTable.rst P0722R3: Implement library support for destroying delete 2019-05-23 23:46:44 +00:00
Makefile.sphinx Add design docs for upcoming file_time_type change. 2018-07-25 02:53:53 +00:00
README.txt Remove test commit. 2015-09-05 05:38:50 +00:00
ReleaseNotes.rst Bump the trunk version to 9.0.0svn 2019-01-16 10:57:02 +00:00
TestingLibcxx.rst [CMake] Support compiler-rt builtins library in tests 2019-02-05 19:50:47 +00:00
UsingLibcxx.rst [libcxx] Slightly improved policy for handling experimental features 2019-06-11 14:48:40 +00:00
conf.py Bump the trunk version to 9.0.0svn 2019-01-16 10:57:02 +00:00
index.rst Add documentation and tests for Clangs C++11 extensions in C++03. 2019-06-11 22:53:49 +00:00

README.txt

libc++ Documentation
====================

The libc++ documentation is written using the Sphinx documentation generator. It is
currently tested with Sphinx 1.1.3.

To build the documents into html configure libc++ with the following cmake options:

  * -DLLVM_ENABLE_SPHINX=ON
  * -DLIBCXX_INCLUDE_DOCS=ON

After configuring libc++ with these options the make rule `docs-libcxx-html`
should be available.