From 7cd2a14069d9d39b42b19a87d9cc6ba238c71924 Mon Sep 17 00:00:00 2001
From: "Jon A. Cruz" <jon@joncruz.org>
Date: Sun, 23 Oct 2011 01:01:33 -0700
Subject: Documentation update pass.

(bzr r10692)
---
 src/libvpsc/blocks.h                 | 14 ++++++--------
 src/libvpsc/constraint.cpp           |  5 +----
 src/libvpsc/constraint.h             | 10 ++++++----
 src/libvpsc/generate-constraints.cpp |  5 ++++-
 src/libvpsc/generate-constraints.h   |  6 +++++-
 5 files changed, 22 insertions(+), 18 deletions(-)

(limited to 'src/libvpsc')

diff --git a/src/libvpsc/blocks.h b/src/libvpsc/blocks.h
index bfe99f271..e3223822e 100644
--- a/src/libvpsc/blocks.h
+++ b/src/libvpsc/blocks.h
@@ -1,10 +1,4 @@
-/**
- * \brief A block structure defined over the variables
- *
- * A block structure defined over the variables such that each block contains
- * 1 or more variables, with the invariant that all constraints inside a block
- * are satisfied by keeping the variables fixed relative to one another
- *
+/*
  * Authors:
  *   Tim Dwyer <tgdwyer@gmail.com>
  *
@@ -24,13 +18,17 @@
 #include <list>
 
 namespace vpsc {
+
 class Block;
 class Variable;
 class Constraint;
+
 /**
  * A block structure defined over the variables such that each block contains
  * 1 or more variables, with the invariant that all constraints inside a block
- * are satisfied by keeping the variables fixed relative to one another
+ * are satisfied by keeping the variables fixed relative to one another.
+ *
+ * @todo check on this class being copy-n-paste duplicated.
  */
 class Blocks : public std::set<Block*>
 {
diff --git a/src/libvpsc/constraint.cpp b/src/libvpsc/constraint.cpp
index af5da941a..2bd173155 100644
--- a/src/libvpsc/constraint.cpp
+++ b/src/libvpsc/constraint.cpp
@@ -1,7 +1,4 @@
-/**
- * \brief A constraint determines a minimum or exact spacing required between
- * two variables.
- *
+/*
  * Authors:
  *   Tim Dwyer <tgdwyer@gmail.com>
  *
diff --git a/src/libvpsc/constraint.h b/src/libvpsc/constraint.h
index 8a8529d7e..a3173359c 100644
--- a/src/libvpsc/constraint.h
+++ b/src/libvpsc/constraint.h
@@ -1,7 +1,4 @@
-/**
- * \brief A constraint determines a minimum or exact spacing required between
- * two variables.
- *
+/*
  * Authors:
  *   Tim Dwyer <tgdwyer@gmail.com>
  *
@@ -17,6 +14,11 @@
 #include "variable.h"
 namespace vpsc {
 
+/**
+ * A constraint determines a minimum or exact spacing required between
+ * two variables.
+ *
+ */
 class Constraint
 {
 	friend std::ostream& operator <<(std::ostream &os,const Constraint &c);
diff --git a/src/libvpsc/generate-constraints.cpp b/src/libvpsc/generate-constraints.cpp
index 0c35ab51c..8dd2d9331 100644
--- a/src/libvpsc/generate-constraints.cpp
+++ b/src/libvpsc/generate-constraints.cpp
@@ -1,6 +1,9 @@
 /**
- * \brief Functions to automatically generate constraints for the
+ * @file
+ * Functions to automatically generate constraints for the
  * rectangular node overlap removal problem.
+ */
+/*
  *
  * Authors:
  *   Tim Dwyer <tgdwyer@gmail.com>
diff --git a/src/libvpsc/generate-constraints.h b/src/libvpsc/generate-constraints.h
index 8b858af3f..b8d7cdcd9 100644
--- a/src/libvpsc/generate-constraints.h
+++ b/src/libvpsc/generate-constraints.h
@@ -1,6 +1,10 @@
 /**
- * \brief Functions to automatically generate constraints for the
+ * @file
+ * Functions to automatically generate constraints for the
  * rectangular node overlap removal problem.
+ */
+/* TODO replace file comment with appropriate doc comment on vpsc::Rectangle */
+/*
  *
  * Authors:
  *   Tim Dwyer <tgdwyer@gmail.com>
-- 
cgit v1.2.3