diff options
| author | Axel Naumann <Axel.Naumann@cern.ch> | 2012-07-25 13:46:11 +0000 |
|---|---|---|
| committer | Axel Naumann <Axel.Naumann@cern.ch> | 2012-07-25 13:46:11 +0000 |
| commit | fc97547b8b0b2544258ec893c0880f1f64f491e3 (patch) | |
| tree | 9a9cb8b2bb5f835de0f0a4ea660efdc428310b56 /docs | |
| parent | 1cee71099c0477c6bf0e8ff76a55b8873ce146b4 (diff) | |
Twine: fix link to source, add link to class doc and container section.
80 char lines.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@160726 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/ProgrammersManual.html | 23 |
1 files changed, 12 insertions, 11 deletions
diff --git a/docs/ProgrammersManual.html b/docs/ProgrammersManual.html index cfcce4d8d2..036c387d7a 100644 --- a/docs/ProgrammersManual.html +++ b/docs/ProgrammersManual.html @@ -507,8 +507,9 @@ small and pervasive enough in LLVM that it should always be passed by value.</p> <div> -<p>The <tt>Twine</tt> class is an efficient way for APIs to accept concatenated -strings. For example, a common LLVM paradigm is to name one instruction based on +<p>The <tt><a href="/doxygen/classllvm_1_1Twine.html">Twine</a></tt> class is an +efficient way for APIs to accept concatenated strings. For example, a common +LLVM paradigm is to name one instruction based on the name of another instruction with a suffix, for example:</p> <div class="doc_code"> @@ -517,17 +518,17 @@ the name of another instruction with a suffix, for example:</p> </pre> </div> -<p>The <tt>Twine</tt> class is effectively a -lightweight <a href="http://en.wikipedia.org/wiki/Rope_(computer_science)">rope</a> +<p>The <tt>Twine</tt> class is effectively a lightweight +<a href="http://en.wikipedia.org/wiki/Rope_(computer_science)">rope</a> which points to temporary (stack allocated) objects. Twines can be implicitly constructed as the result of the plus operator applied to strings (i.e., a C -strings, an <tt>std::string</tt>, or a <tt>StringRef</tt>). The twine delays the -actual concatenation of strings until it is actually required, at which point -it can be efficiently rendered directly into a character array. This avoids -unnecessary heap allocation involved in constructing the temporary results of -string concatenation. See -"<tt><a href="/doxygen/classllvm_1_1Twine_8h-source.html">llvm/ADT/Twine.h</a></tt>" -for more information.</p> +strings, an <tt>std::string</tt>, or a <tt>StringRef</tt>). The twine delays +the actual concatenation of strings until it is actually required, at which +point it can be efficiently rendered directly into a character array. This +avoids unnecessary heap allocation involved in constructing the temporary +results of string concatenation. See +"<tt><a href="/doxygen/Twine_8h_source.html">llvm/ADT/Twine.h</a></tt>" +and <a href="#dss_twine">here</a> for more information.</p> <p>As with a <tt>StringRef</tt>, <tt>Twine</tt> objects point to external memory and should almost never be stored or mentioned directly. They are intended |