From fc97547b8b0b2544258ec893c0880f1f64f491e3 Mon Sep 17 00:00:00 2001 From: Axel Naumann Date: Wed, 25 Jul 2012 13:46:11 +0000 Subject: [PATCH] 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 --- docs/ProgrammersManual.html | 23 ++++++++++++----------- 1 file changed, 12 insertions(+), 11 deletions(-) diff --git a/docs/ProgrammersManual.html b/docs/ProgrammersManual.html index cfcce4d8d21..036c387d7a5 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.

-

The Twine 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 Twine 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:

@@ -517,17 +518,17 @@ the name of another instruction with a suffix, for example:

-

The Twine class is effectively a -lightweight rope +

The Twine class is effectively a lightweight +rope 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 std::string, or a StringRef). 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 -"llvm/ADT/Twine.h" -for more information.

+strings, an std::string, or a StringRef). 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 +"llvm/ADT/Twine.h" +and here for more information.

As with a StringRef, Twine objects point to external memory and should almost never be stored or mentioned directly. They are intended