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
This commit is contained in:
Axel Naumann 2012-07-25 13:46:11 +00:00
parent 1cee71099c
commit fc97547b8b

View File

@ -507,8 +507,9 @@ small and pervasive enough in LLVM that it should always be passed by value.</p>
<div> <div>
<p>The <tt>Twine</tt> class is an efficient way for APIs to accept concatenated <p>The <tt><a href="/doxygen/classllvm_1_1Twine.html">Twine</a></tt> class is an
strings. For example, a common LLVM paradigm is to name one instruction based on 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> the name of another instruction with a suffix, for example:</p>
<div class="doc_code"> <div class="doc_code">
@ -517,17 +518,17 @@ the name of another instruction with a suffix, for example:</p>
</pre> </pre>
</div> </div>
<p>The <tt>Twine</tt> class is effectively a <p>The <tt>Twine</tt> class is effectively a lightweight
lightweight <a href="http://en.wikipedia.org/wiki/Rope_(computer_science)">rope</a> <a href="http://en.wikipedia.org/wiki/Rope_(computer_science)">rope</a>
which points to temporary (stack allocated) objects. Twines can be implicitly 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 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 strings, an <tt>std::string</tt>, or a <tt>StringRef</tt>). The twine delays
actual concatenation of strings until it is actually required, at which point the actual concatenation of strings until it is actually required, at which
it can be efficiently rendered directly into a character array. This avoids point it can be efficiently rendered directly into a character array. This
unnecessary heap allocation involved in constructing the temporary results of avoids unnecessary heap allocation involved in constructing the temporary
string concatenation. See results of string concatenation. See
"<tt><a href="/doxygen/classllvm_1_1Twine_8h-source.html">llvm/ADT/Twine.h</a></tt>" "<tt><a href="/doxygen/Twine_8h_source.html">llvm/ADT/Twine.h</a></tt>"
for more information.</p> 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 <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 and should almost never be stored or mentioned directly. They are intended