Cleanup pass on documentation that was dumping garbage into doxygen output.

(bzr r10696)

6 files changed, 27 insertions, 20 deletions

diff --git a/src/libvpsc/block.h b/src/libvpsc/block.h
index fe4a18b78..a4625b202 100644
--- a/src/libvpsc/block.h
+++ b/src/libvpsc/block.h
@@ -1,8 +1,4 @@
-/**
- * \brief A block is a group of variables that must be moved together to improve
- * the goal function without violating already active constraints.
- * The variables in a block are spanned by a tree of active constraints.
- *
+/*
  * Authors:
  *   Tim Dwyer <tgdwyer@gmail.com>
  *
@@ -21,6 +17,11 @@ namespace vpsc {
 class Variable;
 class Constraint;
 
+/**
+ * A block is a group of variables that must be moved together to improve
+ * the goal function without violating already active constraints.
+ * The variables in a block are spanned by a tree of active constraints.
+ */
 class Block
 {
 	typedef std::vector<Variable*> Variables;
diff --git a/src/libvpsc/csolve_VPSC.h b/src/libvpsc/csolve_VPSC.h
index 81e50d990..92179fc77 100644
--- a/src/libvpsc/csolve_VPSC.h
+++ b/src/libvpsc/csolve_VPSC.h
@@ -1,6 +1,8 @@
 /**
- * \brief Bridge for C programs to access solve_VPSC (which is in C++)
- *
+ * @file
+ * Bridge for C programs to access solve_VPSC (which is in C++).
+ */
+/*
  * Authors:
  *   Tim Dwyer <tgdwyer@gmail.com>
  *
diff --git a/src/libvpsc/pairingheap/PairingHeap.cpp b/src/libvpsc/pairingheap/PairingHeap.cpp
index 202980b70..6e003f99c 100644
--- a/src/libvpsc/pairingheap/PairingHeap.cpp
+++ b/src/libvpsc/pairingheap/PairingHeap.cpp
@@ -1,12 +1,14 @@
 /**
- * \brief Pairing heap datastructure implementation
+ * @file
+ * Pairing heap datastructure implementation.
  *
  * Based on example code in "Data structures and Algorithm Analysis in C++"
  * by Mark Allen Weiss, used and released under the LGPL by permission
  * of the author.
  *
  * No promises about correctness.  Use at your own risk!
- *
+ */
+/*
  * Authors:
  *   Mark Allen Weiss
  *   Tim Dwyer <tgdwyer@gmail.com>
diff --git a/src/libvpsc/pairingheap/PairingHeap.h b/src/libvpsc/pairingheap/PairingHeap.h
index 6159e96c1..62c782d5d 100644
--- a/src/libvpsc/pairingheap/PairingHeap.h
+++ b/src/libvpsc/pairingheap/PairingHeap.h
@@ -1,10 +1,4 @@
-/**
- * \brief Pairing heap datastructure implementation
- *
- * Based on example code in "Data structures and Algorithm Analysis in C++"
- * by Mark Allen Weiss, used and released under the LGPL by permission
- * of the author.
- *
+/*
  * No promises about correctness.  Use at your own risk!
  *
  * Authors:
@@ -67,6 +61,13 @@ public:
 	virtual bool isLessThan(T const &lhs, T const &rhs) const = 0;
 };
 
+/**
+ * Pairing heap datastructure implementation.
+ *
+ * Based on example code in "Data structures and Algorithm Analysis in C++"
+ * by Mark Allen Weiss, used and released under the LGPL by permission
+ * of the author.
+ */
 template <class T>
 class PairingHeap
 {
diff --git a/src/libvpsc/solve_VPSC.h b/src/libvpsc/solve_VPSC.h
index 0f919a22a..84f646226 100644
--- a/src/libvpsc/solve_VPSC.h
+++ b/src/libvpsc/solve_VPSC.h
@@ -1,7 +1,9 @@
 /**
- * \brief Solve an instance of the "Variable Placement with Separation
+ * @file
+ * Solve an instance of the "Variable Placement with Separation
  * Constraints" problem.
- *
+ */
+/*
  * Authors:
  *   Tim Dwyer <tgdwyer@gmail.com>
  *
diff --git a/src/libvpsc/variable.h b/src/libvpsc/variable.h
index 25239ff20..022754a7d 100644
--- a/src/libvpsc/variable.h
+++ b/src/libvpsc/variable.h
@@ -1,5 +1,4 @@
-/**
- *
+/*
  * Authors:
  *   Tim Dwyer <tgdwyer@gmail.com>
  *