From: Tim Northover Date: Mon, 3 Apr 2017 22:24:32 +0000 (+0000) Subject: Update stale doxygen links in ProgrammersManual.rst X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=9d740a4a716ff38d45db605e29f16e0ef627e38d;p=llvm Update stale doxygen links in ProgrammersManual.rst Patch by Wei-Ren Chen. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@299395 91177308-0d34-0410-b5e6-96231b3b80d8 --- diff --git a/docs/ProgrammersManual.rst b/docs/ProgrammersManual.rst index decac60d6d2..4fb67e1e6d5 100644 --- a/docs/ProgrammersManual.rst +++ b/docs/ProgrammersManual.rst @@ -32,7 +32,7 @@ to know when working in the LLVM infrastructure, and the second describes the Core LLVM classes. In the future this manual will be extended with information describing how to use extension libraries, such as dominator information, CFG traversal routines, and useful utilities like the ``InstVisitor`` (`doxygen -`__) template. +`__) template. .. _general: @@ -108,7 +108,7 @@ they don't have some drawbacks (primarily stemming from the fact that ``dynamic_cast<>`` only works on classes that have a v-table). Because they are used so often, you must know what they do and how they work. All of these templates are defined in the ``llvm/Support/Casting.h`` (`doxygen -`__) file (note that you very +`__) file (note that you very rarely have to include this file directly). ``isa<>``: @@ -225,7 +225,7 @@ and clients can call it using any one of: Similarly, APIs which need to return a string may return a ``StringRef`` instance, which can be used directly or converted to an ``std::string`` using the ``str`` member function. See ``llvm/ADT/StringRef.h`` (`doxygen -`__) for more +`__) for more information. You should rarely use the ``StringRef`` class directly, because it contains @@ -974,7 +974,7 @@ The ``function_ref`` class template ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ The ``function_ref`` -(`doxygen `__) class +(`doxygen `__) class template represents a reference to a callable object, templated over the type of the callable. This is a good choice for passing a callback to a function, if you don't need to hold onto the callback after the function returns. In this @@ -1024,7 +1024,7 @@ you don't want them to always be noisy. A standard compromise is to comment them out, allowing you to enable them if you need them in the future. The ``llvm/Support/Debug.h`` (`doxygen -`__) file provides a macro named +`__) file provides a macro named ``DEBUG()`` that is a much nicer solution to this problem. Basically, you can put arbitrary code into the argument of the ``DEBUG`` macro, and it is only executed if '``opt``' (or any other tool) is run with the '``-debug``' command @@ -1121,7 +1121,7 @@ The ``Statistic`` class & ``-stats`` option ------------------------------------------- The ``llvm/ADT/Statistic.h`` (`doxygen -`__) file provides a class +`__) file provides a class named ``Statistic`` that is used as a unified way to keep track of what the LLVM compiler is doing and how effective various optimizations are. It is useful to see what optimizations are contributing to making a particular program run @@ -2819,7 +2819,7 @@ Replacing individual instructions """"""""""""""""""""""""""""""""" Including "`llvm/Transforms/Utils/BasicBlockUtils.h -`_" permits use of two +`_" permits use of two very useful replace functions: ``ReplaceInstWithValue`` and ``ReplaceInstWithInst``. @@ -2915,7 +2915,7 @@ is easier to read and write than the equivalent FunctionType *ft = FunctionType::get(Type::Int8Ty, params, false); See the `class comment -`_ for more details. +`_ for more details. .. _threading: @@ -3336,7 +3336,7 @@ The Core LLVM Class Hierarchy Reference ``#include "llvm/IR/Type.h"`` -header source: `Type.h `_ +header source: `Type.h `_ doxygen info: `Type Clases `_ @@ -3440,7 +3440,7 @@ The ``Module`` class ``#include "llvm/IR/Module.h"`` -header source: `Module.h `_ +header source: `Module.h `_ doxygen info: `Module Class `_ @@ -3527,7 +3527,7 @@ The ``Value`` class ``#include "llvm/IR/Value.h"`` -header source: `Value.h `_ +header source: `Value.h `_ doxygen info: `Value Class `_ @@ -3618,7 +3618,7 @@ The ``User`` class ``#include "llvm/IR/User.h"`` -header source: `User.h `_ +header source: `User.h `_ doxygen info: `User Class `_ @@ -3665,7 +3665,7 @@ The ``Instruction`` class ``#include "llvm/IR/Instruction.h"`` header source: `Instruction.h -`_ +`_ doxygen info: `Instruction Class `_ @@ -3813,7 +3813,7 @@ The ``GlobalValue`` class ``#include "llvm/IR/GlobalValue.h"`` header source: `GlobalValue.h -`_ +`_ doxygen info: `GlobalValue Class `_ @@ -3871,7 +3871,7 @@ The ``Function`` class ``#include "llvm/IR/Function.h"`` -header source: `Function.h `_ +header source: `Function.h `_ doxygen info: `Function Class `_ @@ -3980,7 +3980,7 @@ The ``GlobalVariable`` class ``#include "llvm/IR/GlobalVariable.h"`` header source: `GlobalVariable.h -`_ +`_ doxygen info: `GlobalVariable Class `_ @@ -4038,7 +4038,7 @@ The ``BasicBlock`` class ``#include "llvm/IR/BasicBlock.h"`` header source: `BasicBlock.h -`_ +`_ doxygen info: `BasicBlock Class `_