From: Sean Silva Date: Wed, 2 Jan 2013 13:07:47 +0000 (+0000) Subject: docs: Fix up HTML links to proper reST links. X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=159cc9e6f6c9cdfe571a90d341c29b31bf1007fe;p=clang 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 --- diff --git a/docs/InternalsManual.rst b/docs/InternalsManual.rst index bbfcc54b65..3a914170e2 100644 --- a/docs/InternalsManual.rst +++ b/docs/InternalsManual.rst @@ -525,7 +525,7 @@ the ``CharSourceRange`` class. The Driver Library ================== -The clang Driver and library are documented `here `_. +The clang Driver and library are documented :doc:`here `. Precompiled Headers =================== @@ -534,7 +534,7 @@ Clang supports two implementations of precompiled headers. The default implementation, precompiled headers (:doc:`PCH `) uses a serialized representation of Clang's internal data structures, encoded with the `LLVM bitstream format `_. -Pretokenized headers (`PTH `_), on the other hand, contain a +Pretokenized headers (:doc:`PTH `), on the other hand, contain a serialized representation of the tokens encountered when preprocessing a header (and anything that header includes). diff --git a/docs/JSONCompilationDatabase.rst b/docs/JSONCompilationDatabase.rst index 51482648d5..c5852ebfb5 100644 --- a/docs/JSONCompilationDatabase.rst +++ b/docs/JSONCompilationDatabase.rst @@ -34,7 +34,7 @@ of compilation databases for Unix Makefile builds (Ninja builds in the works) with the option ``CMAKE_EXPORT_COMPILE_COMMANDS``. Clang's tooling interface supports reading compilation databases; see -the `LibTooling documentation `_. libclang and its +the :doc:`LibTooling documentation `. libclang and its python bindings also support this (since clang 3.2); see `CXCompilationDatabase.h `_. diff --git a/docs/LanguageExtensions.rst b/docs/LanguageExtensions.rst index c3e2c83d13..be6ea52bf3 100644 --- a/docs/LanguageExtensions.rst +++ b/docs/LanguageExtensions.rst @@ -87,8 +87,8 @@ for support for non-standardized features, i.e. features not prefixed ``c_``, ``cxx_`` or ``objc_``. 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 +`. If the ``-pedantic-errors`` option is given, ``__has_extension`` is equivalent to ``__has_feature``. @@ -925,8 +925,8 @@ Use ``__has_feature(objc_instancetype)`` to determine whether the Automatic reference counting ---------------------------- -Clang provides support for `automated reference counting -`_ in Objective-C, which eliminates the need +Clang provides support for :doc:`automated reference counting +` in Objective-C, which eliminates the need for manual ``retain``/``release``/``autorelease`` message sends. There are two feature macros associated with automatic reference counting: ``__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 automated reference counting also includes support for ``__weak`` pointers to Objective-C objects. +.. _objc-fixed-enum: + Enumerations with a fixed underlying type ----------------------------------------- @@ -1010,8 +1012,8 @@ management (autorelease). Object Literals and Subscripting -------------------------------- -Clang provides support for `Object Literals and Subscripting -`_ in Objective-C, which simplifies common Objective-C +Clang provides support for :doc:`Object Literals and Subscripting +` in Objective-C, which simplifies common Objective-C programming patterns, makes programs more concise, and improves the safety of container creation. There are several feature macros associated with object literals and subscripting: ``__has_feature(objc_array_literals)`` tests the diff --git a/docs/LibASTMatchers.rst b/docs/LibASTMatchers.rst index 56a1a7fa4b..738de79d5d 100644 --- a/docs/LibASTMatchers.rst +++ b/docs/LibASTMatchers.rst @@ -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 tools or query tools. -We assume basic knowledge about the Clang AST. See the `Introduction to the -Clang AST `_ if you want to learn more about -how the AST is structured. +We assume basic knowledge about the Clang AST. See the :doc:`Introduction +to the Clang AST ` if you want to learn more +about how the AST is structured. .. FIXME: create tutorial and link to the tutorial @@ -52,7 +52,7 @@ AST matchers ` later in this document. The precondition to using the matchers is to understand how the AST for what you want to match looks like. The -`Introduction to the Clang AST `_ teaches you +:doc:`Introduction to the Clang AST ` teaches you how to dump a translation unit's AST into a human readable format. .. FIXME: Introduce link to ASTMatchersTutorial.html diff --git a/docs/LibTooling.rst b/docs/LibTooling.rst index 8c2a126fcc..b739aed14a 100644 --- a/docs/LibTooling.rst +++ b/docs/LibTooling.rst @@ -7,7 +7,7 @@ This document will provide a basic walkthrough of how to write a tool using LibTooling. For the information on how to setup Clang Tooling for LLVM see -`HowToSetupToolingForLLVM.html `_ +:doc:`HowToSetupToolingForLLVM` Introduction ------------ diff --git a/docs/ObjectiveCLiterals.rst b/docs/ObjectiveCLiterals.rst index 5fcb25f7f4..92e4fb65cd 100644 --- a/docs/ObjectiveCLiterals.rst +++ b/docs/ObjectiveCLiterals.rst @@ -164,9 +164,7 @@ value: The expression ``@(AVAudioQualityMax)`` converts ``AVAudioQualityMax`` to an integer type, and boxes the value accordingly. If the enum has a -`fixed underlying -type `_ -as in: +:ref:`fixed underlying type ` as in: .. code-block:: objc @@ -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 creation method according to the underlying type of the enum, which can -be a `fixed underlying -type `_ +be a :ref:`fixed underlying type ` or a compiler-defined integer type capable of representing the values of all the members of the enumeration: diff --git a/docs/PCHInternals.rst b/docs/PCHInternals.rst index bc73d7be37..6fe53d9316 100644 --- a/docs/PCHInternals.rst +++ b/docs/PCHInternals.rst @@ -7,7 +7,7 @@ Precompiled Header and Modules Internals 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 -see the `User's Manual `_. +see the :ref:`User's Manual `. Using Precompiled Headers with ``clang`` ---------------------------------------- diff --git a/docs/Tooling.rst b/docs/Tooling.rst index b2884b6710..b1281fc09e 100644 --- a/docs/Tooling.rst +++ b/docs/Tooling.rst @@ -33,7 +33,7 @@ Do not use LibClang when you...: Clang Plugins ------------- -`Clang Plugins `_ allow you to run additional actions on the +:doc:`Clang Plugins ` allow you to run additional actions on the 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 environment. @@ -60,7 +60,7 @@ Do not use Clang Plugins when you...: LibTooling ---------- -`LibTooling `_ is a C++ interface aimed at writing standalone +:doc:`LibTooling ` is a C++ interface aimed at writing standalone tools, as well as integrating into services that run clang tools. Canonical examples of when to use LibTooling: @@ -85,7 +85,7 @@ Do not use LibTooling when you...: Clang Tools ----------- -`Clang tools `_ are a collection of specific developer tools +:doc:`Clang tools ` are a collection of specific developer tools built on top of the LibTooling infrastructure as part of the Clang project. They are targeted at automating and improving core development activities of C/C++ developers.