diff options
author | Dmitri Gribenko <gribozavr@gmail.com> | 2012-09-14 14:57:36 +0000 |
---|---|---|
committer | Dmitri Gribenko <gribozavr@gmail.com> | 2012-09-14 14:57:36 +0000 |
commit | c5252da873d547a19069eaf9030fec203f128f66 (patch) | |
tree | 0c83882516664cffb398aacead9a63a9c0c9b1dc /include/llvm/ADT/DAGDeltaAlgorithm.h | |
parent | d0807690de6c735af84e35dd76a30420eaded16b (diff) |
Fix Doxygen issues:
* wrap code blocks in \code ... \endcode;
* refer to parameter names in paragraphs correctly (\arg is not what most
people want -- it starts a new paragraph);
* use \param instead of \arg to document parameters in order to be consistent
with the rest of the codebase.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@163902 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'include/llvm/ADT/DAGDeltaAlgorithm.h')
-rw-r--r-- | include/llvm/ADT/DAGDeltaAlgorithm.h | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/include/llvm/ADT/DAGDeltaAlgorithm.h b/include/llvm/ADT/DAGDeltaAlgorithm.h index 45a5eeb180..2dfed075de 100644 --- a/include/llvm/ADT/DAGDeltaAlgorithm.h +++ b/include/llvm/ADT/DAGDeltaAlgorithm.h @@ -48,15 +48,15 @@ public: public: virtual ~DAGDeltaAlgorithm() {} - /// Run - Minimize the DAG formed by the \arg Changes vertices and the \arg - /// Dependencies edges by executing \see ExecuteOneTest() on subsets of + /// Run - Minimize the DAG formed by the \p Changes vertices and the + /// \p Dependencies edges by executing \see ExecuteOneTest() on subsets of /// changes and returning the smallest set which still satisfies the test - /// predicate and the input \arg Dependencies. + /// predicate and the input \p Dependencies. /// /// \param Changes The list of changes. /// /// \param Dependencies The list of dependencies amongst changes. For each - /// (x,y) in \arg Dependencies, both x and y must be in \arg Changes. The + /// (x,y) in \p Dependencies, both x and y must be in \p Changes. The /// minimization algorithm guarantees that for each tested changed set S, /// \f$ x \in S \f$ implies \f$ y \in S \f$. It is an error to have cyclic /// dependencies. @@ -68,7 +68,7 @@ public: const changesetlist_ty &Sets, const changeset_ty &Required) {} - /// ExecuteOneTest - Execute a single test predicate on the change set \arg S. + /// ExecuteOneTest - Execute a single test predicate on the change set \p S. virtual bool ExecuteOneTest(const changeset_ty &S) = 0; }; |