vpsc: doxygen comment

diff --git a/lib/vpsc/solve_VPSC.cpp b/lib/vpsc/solve_VPSC.cpp
index e0ce311e988c379987fd7b7694ddd6a1771e8812..46b4986af99bec717fd70d10117dd6a0bb4e1d7d 100644 (file)
--- a/lib/vpsc/solve_VPSC.cpp
+++ b/lib/vpsc/solve_VPSC.cpp
@@ -393,4 +393,19 @@ bool VPSC::blockGraphIsCyclic() {
        }
        return false;
 }
-
+/**
+ * @dir lib/vpsc
+ * @brief library for solving the
+ *        %Variable Placement with Separation Constraints problem
+ *        for lib/neatogen
+ *
+ * This is a quadratic programming problem in which the squared differences
+ * between a placement vector and some ideal placement are minimized subject
+ * to a set of separation constraints. This is very useful in a number of layout problems.
+ *
+ * References:
+ * - https://www.adaptagrams.org/documentation/libvpsc.html
+ * - Tim Dwyer, Kim Marriott, and Peter J. Stuckey. Fast node overlap removal.
+ *   In Proceedings 13th International Symposium on Graph Drawing (GD '05),
+ *   volume 3843 of LNCS, pages 153-164. Springer, 2006.
+ */