llvm.org GIT mirror llvm / 4e0ae44
Fix Doxygen issues: wrap code examples in \code and use \p to refer to parameters. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@163984 91177308-0d34-0410-b5e6-96231b3b80d8 Dmitri Gribenko 7 years ago
3 changed file(s) with 8 addition(s) and 5 deletion(s). Raw diff Collapse all Expand all
3232 ///
3333 /// Here is a simple example using integers:
3434 ///
35 /// \code
3536 /// EquivalenceClasses EC;
3637 /// EC.unionSets(1, 2); // insert 1, 2 into the same set
3738 /// EC.insert(4); EC.insert(5); // insert 4, 5 into own sets
4546 /// cerr << *MI << " "; // Print member.
4647 /// cerr << "\n"; // Finish set.
4748 /// }
49 /// \endcode
4850 ///
4951 /// This example prints:
5052 /// 4
119119 /// Abstract base class for registry listeners, which are informed when new
120120 /// entries are added to the registry. Simply subclass and instantiate:
121121 ///
122 /// \code
122123 /// class CollectorPrinter : public Registry::listener {
123124 /// protected:
124125 /// void registered(const Registry::entry &e) {
130131 /// };
131132 ///
132133 /// CollectorPrinter Printer;
133 ///
134 /// \endcode
134135 class listener {
135136 listener *Prev, *Next;
136137
198198 return Kind >= UserClass0;
199199 }
200200
201 /// isRelatedTo - Check whether this class is "related" to \arg RHS. Classes
201 /// isRelatedTo - Check whether this class is "related" to \p RHS. Classes
202202 /// are related if they are in the same class hierarchy.
203203 bool isRelatedTo(const ClassInfo &RHS) const {
204204 // Tokens are only related to tokens.
237237 return Root == RHSRoot;
238238 }
239239
240 /// isSubsetOf - Test whether this class is a subset of \arg RHS;
240 /// isSubsetOf - Test whether this class is a subset of \p RHS.
241241 bool isSubsetOf(const ClassInfo &RHS) const {
242242 // This is a subset of RHS if it is the same class...
243243 if (this == &RHS)
500500 }
501501
502502 /// couldMatchAmbiguouslyWith - Check whether this matchable could
503 /// ambiguously match the same set of operands as \arg RHS (without being a
503 /// ambiguously match the same set of operands as \p RHS (without being a
504504 /// strictly superior match).
505505 bool couldMatchAmbiguouslyWith(const MatchableInfo &RHS) {
506506 // The primary comparator is the instruction mnemonic.
20632063 static void emitIsSubclass(CodeGenTarget &Target,
20642064 std::vector &Infos,
20652065 raw_ostream &OS) {
2066 OS << "/// isSubclass - Compute whether \\arg A is a subclass of \\arg B.\n";
2066 OS << "/// isSubclass - Compute whether \\p A is a subclass of \\p B.\n";
20672067 OS << "static bool isSubclass(MatchClassKind A, MatchClassKind B) {\n";
20682068 OS << " if (A == B)\n";
20692069 OS << " return true;\n\n";