* Escape &, <, and >
authorMisha Brukman <brukman+llvm@gmail.com>
Thu, 12 Aug 2004 19:58:43 +0000 (19:58 +0000)
committerMisha Brukman <brukman+llvm@gmail.com>
Thu, 12 Aug 2004 19:58:43 +0000 (19:58 +0000)
* Wrap code in <tt> or for larger blocks, <div class="doc_text">
* Wrap lines at 80 cols

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@15705 91177308-0d34-0410-b5e6-96231b3b80d8

docs/ExtendingLLVM.html

index 775a431db0cd18368ea4badcecd48d6ed3e681f4..2e8982b8a50d5473789e15780383fbbf4f854c2e 100644 (file)
@@ -220,7 +220,8 @@ installations.</span> Only add new types if it is absolutely necessary.</p>
     add enum for the type</li>
 
 <li><tt>llvm/include/llvm/Type.h</tt>:
-    add ID number for the new type; add a forward declaration of the type also</li>
+    add ID number for the new type; add a forward declaration of the type
+    also</li>
 
 <li><tt>llvm/include/llvm/DerivedType.h</tt>:
     add new class to represent new class in the hierarchy; add forward 
@@ -228,29 +229,37 @@ installations.</span> Only add new types if it is absolutely necessary.</p>
 
 <li><tt>llvm/lib/VMCore/Type.cpp</tt>:
     add support for derived type to: 
-    std::string getTypeDescription(const Type &Ty,
-      std::vector<const Type *> &TypeStack)
-    bool TypesEqual(const Type* Ty, const Type *Ty2,
-      std::map<const Type *, const Type *> & EqTypes)
-    add necessary member functions for type, and factory
-    methods</li>
+<div class="doc_code">
+<pre>
+std::string getTypeDescription(const Type &amp;Ty,
+  std::vector&lt;const Type*&gt; &amp;TypeStack)
+bool TypesEqual(const Type *Ty, const Type *Ty2,
+  std::map&lt;const Type*, const Type*&gt; &amp; EqTypes)
+</pre>
+</div>
+    add necessary member functions for type, and factory methods</li>
 
 <li><tt>llvm/lib/AsmReader/Lexer.l</tt>:
     add ability to parse in the type from text assembly</li>
 
 <li><tt>llvm/lib/ByteCode/Writer/Writer.cpp</tt>:
-    modify void BytecodeWriter::outputType(const Type *T) to
-    serialize your type</li>
+    modify <tt>void BytecodeWriter::outputType(const Type *T)</tt> to serialize
+    your type</li>
 
 <li><tt>llvm/lib/ByteCode/Reader/Reader.cpp</tt>:
-    modify const Type *BytecodeReader::ParseType() to
-    read your data type</li> 
+    modify <tt>const Type *BytecodeReader::ParseType()</tt> to read your data
+    type</li> 
 
 <li><tt>llvm/lib/VMCore/AsmWriter.cpp</tt>:
-    modify void calcTypeName(const Type *Ty,
-                             std::vector<const Type *> &TypeStack,
-                             std::map<const Type *,std::string> &TypeNames,
-                             std::string & Result)
+    modify
+<div class="doc_code">
+<pre>
+void calcTypeName(const Type *Ty,
+                  std::vector&lt;const Type*&gt; &amp;TypeStack,
+                  std::map&lt;const Type*,std::string&gt; &amp;TypeNames,
+                  std::string &amp; Result)
+</pre>
+</div>
     to output the new derived type
 </li>