Skip to content
Snippets Groups Projects
Commit 159cc9e6 authored by Sean Silva's avatar Sean Silva
Browse files

docs: Fix up HTML links to proper reST links.

git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@171382 91177308-0d34-0410-b5e6-96231b3b80d8
parent 9cc4c39c
No related branches found
No related tags found
No related merge requests found
...@@ -525,7 +525,7 @@ the ``CharSourceRange`` class. ...@@ -525,7 +525,7 @@ the ``CharSourceRange`` class.
The Driver Library The Driver Library
================== ==================
The clang Driver and library are documented `here <DriverInternals.html>`_. The clang Driver and library are documented :doc:`here <DriverInternals>`.
Precompiled Headers Precompiled Headers
=================== ===================
...@@ -534,7 +534,7 @@ Clang supports two implementations of precompiled headers. The default ...@@ -534,7 +534,7 @@ Clang supports two implementations of precompiled headers. The default
implementation, precompiled headers (:doc:`PCH <PCHInternals>`) uses a implementation, precompiled headers (:doc:`PCH <PCHInternals>`) uses a
serialized representation of Clang's internal data structures, encoded with the serialized representation of Clang's internal data structures, encoded with the
`LLVM bitstream format <http://llvm.org/docs/BitCodeFormat.html>`_. `LLVM bitstream format <http://llvm.org/docs/BitCodeFormat.html>`_.
Pretokenized headers (`PTH <PTHInternals.html>`_), on the other hand, contain a Pretokenized headers (:doc:`PTH <PTHInternals>`), on the other hand, contain a
serialized representation of the tokens encountered when preprocessing a header serialized representation of the tokens encountered when preprocessing a header
(and anything that header includes). (and anything that header includes).
......
...@@ -34,7 +34,7 @@ of compilation databases for Unix Makefile builds (Ninja builds in the ...@@ -34,7 +34,7 @@ of compilation databases for Unix Makefile builds (Ninja builds in the
works) with the option ``CMAKE_EXPORT_COMPILE_COMMANDS``. works) with the option ``CMAKE_EXPORT_COMPILE_COMMANDS``.
Clang's tooling interface supports reading compilation databases; see Clang's tooling interface supports reading compilation databases; see
the `LibTooling documentation <LibTooling.html>`_. libclang and its the :doc:`LibTooling documentation <LibTooling>`. libclang and its
python bindings also support this (since clang 3.2); see python bindings also support this (since clang 3.2); see
`CXCompilationDatabase.h </doxygen/group__COMPILATIONDB.html>`_. `CXCompilationDatabase.h </doxygen/group__COMPILATIONDB.html>`_.
......
...@@ -87,8 +87,8 @@ for support for non-standardized features, i.e. features not prefixed ``c_``, ...@@ -87,8 +87,8 @@ for support for non-standardized features, i.e. features not prefixed ``c_``,
``cxx_`` or ``objc_``. ``cxx_`` or ``objc_``.
Another use of ``__has_feature`` is to check for compiler features not related Another use of ``__has_feature`` is to check for compiler features not related
to the language standard, such as e.g. `AddressSanitizer to the language standard, such as e.g. :doc:`AddressSanitizer
<AddressSanitizer.html>`_. <AddressSanitizer>`.
If the ``-pedantic-errors`` option is given, ``__has_extension`` is equivalent If the ``-pedantic-errors`` option is given, ``__has_extension`` is equivalent
to ``__has_feature``. to ``__has_feature``.
...@@ -925,8 +925,8 @@ Use ``__has_feature(objc_instancetype)`` to determine whether the ...@@ -925,8 +925,8 @@ Use ``__has_feature(objc_instancetype)`` to determine whether the
Automatic reference counting Automatic reference counting
---------------------------- ----------------------------
Clang provides support for `automated reference counting Clang provides support for :doc:`automated reference counting
<AutomaticReferenceCounting.html>`_ in Objective-C, which eliminates the need <AutomaticReferenceCounting>` in Objective-C, which eliminates the need
for manual ``retain``/``release``/``autorelease`` message sends. There are two for manual ``retain``/``release``/``autorelease`` message sends. There are two
feature macros associated with automatic reference counting: feature macros associated with automatic reference counting:
``__has_feature(objc_arc)`` indicates the availability of automated reference ``__has_feature(objc_arc)`` indicates the availability of automated reference
...@@ -934,6 +934,8 @@ counting in general, while ``__has_feature(objc_arc_weak)`` indicates that ...@@ -934,6 +934,8 @@ counting in general, while ``__has_feature(objc_arc_weak)`` indicates that
automated reference counting also includes support for ``__weak`` pointers to automated reference counting also includes support for ``__weak`` pointers to
Objective-C objects. Objective-C objects.
.. _objc-fixed-enum:
Enumerations with a fixed underlying type Enumerations with a fixed underlying type
----------------------------------------- -----------------------------------------
...@@ -1010,8 +1012,8 @@ management (autorelease). ...@@ -1010,8 +1012,8 @@ management (autorelease).
Object Literals and Subscripting Object Literals and Subscripting
-------------------------------- --------------------------------
Clang provides support for `Object Literals and Subscripting Clang provides support for :doc:`Object Literals and Subscripting
<ObjectiveCLiterals.html>`_ in Objective-C, which simplifies common Objective-C <ObjectiveCLiterals>` in Objective-C, which simplifies common Objective-C
programming patterns, makes programs more concise, and improves the safety of programming patterns, makes programs more concise, and improves the safety of
container creation. There are several feature macros associated with object container creation. There are several feature macros associated with object
literals and subscripting: ``__has_feature(objc_array_literals)`` tests the literals and subscripting: ``__has_feature(objc_array_literals)`` tests the
......
...@@ -7,9 +7,9 @@ nodes of the AST and execute code that uses the matched nodes. Combined with ...@@ -7,9 +7,9 @@ nodes of the AST and execute code that uses the matched nodes. Combined with
:doc:`LibTooling`, LibASTMatchers helps to write code-to-code transformation :doc:`LibTooling`, LibASTMatchers helps to write code-to-code transformation
tools or query tools. tools or query tools.
We assume basic knowledge about the Clang AST. See the `Introduction to the We assume basic knowledge about the Clang AST. See the :doc:`Introduction
Clang AST <IntroductionToTheClangAST.html>`_ if you want to learn more about to the Clang AST <IntroductionToTheClangAST>` if you want to learn more
how the AST is structured. about how the AST is structured.
.. FIXME: create tutorial and link to the tutorial .. FIXME: create tutorial and link to the tutorial
...@@ -52,7 +52,7 @@ AST matchers <astmatchers-writing>` later in this document. ...@@ -52,7 +52,7 @@ AST matchers <astmatchers-writing>` later in this document.
The precondition to using the matchers is to understand how the AST for what you The precondition to using the matchers is to understand how the AST for what you
want to match looks like. The want to match looks like. The
`Introduction to the Clang AST <IntroductionToTheClangAST.html>`_ teaches you :doc:`Introduction to the Clang AST <IntroductionToTheClangAST>` teaches you
how to dump a translation unit's AST into a human readable format. how to dump a translation unit's AST into a human readable format.
.. FIXME: Introduce link to ASTMatchersTutorial.html .. FIXME: Introduce link to ASTMatchersTutorial.html
......
...@@ -7,7 +7,7 @@ This document will provide a basic walkthrough of how to write a tool using ...@@ -7,7 +7,7 @@ This document will provide a basic walkthrough of how to write a tool using
LibTooling. LibTooling.
For the information on how to setup Clang Tooling for LLVM see For the information on how to setup Clang Tooling for LLVM see
`HowToSetupToolingForLLVM.html <HowToSetupToolingForLLVM.html>`_ :doc:`HowToSetupToolingForLLVM`
Introduction Introduction
------------ ------------
......
...@@ -164,9 +164,7 @@ value: ...@@ -164,9 +164,7 @@ value:
The expression ``@(AVAudioQualityMax)`` converts ``AVAudioQualityMax`` The expression ``@(AVAudioQualityMax)`` converts ``AVAudioQualityMax``
to an integer type, and boxes the value accordingly. If the enum has a to an integer type, and boxes the value accordingly. If the enum has a
`fixed underlying :ref:`fixed underlying type <objc-fixed-enum>` as in:
type <http://clang.llvm.org/docs/LanguageExtensions.html#objc_fixed_enum>`_
as in:
.. code-block:: objc .. code-block:: objc
...@@ -178,8 +176,7 @@ then the fixed underlying type will be used to select the correct ...@@ -178,8 +176,7 @@ then the fixed underlying type will be used to select the correct
Boxing a value of enum type will result in a ``NSNumber`` pointer with a Boxing a value of enum type will result in a ``NSNumber`` pointer with a
creation method according to the underlying type of the enum, which can creation method according to the underlying type of the enum, which can
be a `fixed underlying be a :ref:`fixed underlying type <objc-fixed-enum>`
type <http://clang.llvm.org/docs/LanguageExtensions.html#objc_fixed_enum>`_
or a compiler-defined integer type capable of representing the values of or a compiler-defined integer type capable of representing the values of
all the members of the enumeration: all the members of the enumeration:
......
...@@ -7,7 +7,7 @@ Precompiled Header and Modules Internals ...@@ -7,7 +7,7 @@ Precompiled Header and Modules Internals
This document describes the design and implementation of Clang's precompiled This document describes the design and implementation of Clang's precompiled
headers (PCH) and modules. If you are interested in the end-user view, please headers (PCH) and modules. If you are interested in the end-user view, please
see the `User's Manual <UsersManual.html#precompiledheaders>`_. see the :ref:`User's Manual <usersmanual-precompiled-headers>`.
Using Precompiled Headers with ``clang`` Using Precompiled Headers with ``clang``
---------------------------------------- ----------------------------------------
......
...@@ -33,7 +33,7 @@ Do not use LibClang when you...: ...@@ -33,7 +33,7 @@ Do not use LibClang when you...:
Clang Plugins Clang Plugins
------------- -------------
`Clang Plugins <ClangPlugins.html>`_ allow you to run additional actions on the :doc:`Clang Plugins <ClangPlugins>` allow you to run additional actions on the
AST as part of a compilation. Plugins are dynamic libraries that are loaded at AST as part of a compilation. Plugins are dynamic libraries that are loaded at
runtime by the compiler, and they're easy to integrate into your build runtime by the compiler, and they're easy to integrate into your build
environment. environment.
...@@ -60,7 +60,7 @@ Do not use Clang Plugins when you...: ...@@ -60,7 +60,7 @@ Do not use Clang Plugins when you...:
LibTooling LibTooling
---------- ----------
`LibTooling <LibTooling.html>`_ is a C++ interface aimed at writing standalone :doc:`LibTooling <LibTooling>` is a C++ interface aimed at writing standalone
tools, as well as integrating into services that run clang tools. Canonical tools, as well as integrating into services that run clang tools. Canonical
examples of when to use LibTooling: examples of when to use LibTooling:
...@@ -85,7 +85,7 @@ Do not use LibTooling when you...: ...@@ -85,7 +85,7 @@ Do not use LibTooling when you...:
Clang Tools Clang Tools
----------- -----------
`Clang tools <ClangTools.html>`_ are a collection of specific developer tools :doc:`Clang tools <ClangTools>` are a collection of specific developer tools
built on top of the LibTooling infrastructure as part of the Clang project. built on top of the LibTooling infrastructure as part of the Clang project.
They are targeted at automating and improving core development activities of They are targeted at automating and improving core development activities of
C/C++ developers. C/C++ developers.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment