aboutsummaryrefslogtreecommitdiff
path: root/devel/klassmodeler/pkg-descr
diff options
context:
space:
mode:
authorYing-Chieh Liao <ijliao@FreeBSD.org>2004-06-29 09:59:33 +0000
committerYing-Chieh Liao <ijliao@FreeBSD.org>2004-06-29 09:59:33 +0000
commit234c786c198f1222bd733ed8bb04578239339eee (patch)
tree51cec464359887ded6c7c5664084eb4c1bace983 /devel/klassmodeler/pkg-descr
parentec6111b2829222f1e191ebdd051f54ede45d2496 (diff)
Notes
Diffstat (limited to 'devel/klassmodeler/pkg-descr')
-rw-r--r--devel/klassmodeler/pkg-descr19
1 files changed, 19 insertions, 0 deletions
diff --git a/devel/klassmodeler/pkg-descr b/devel/klassmodeler/pkg-descr
new file mode 100644
index 000000000000..852768dd9aba
--- /dev/null
+++ b/devel/klassmodeler/pkg-descr
@@ -0,0 +1,19 @@
+The KlassModeler is a tool for visually creating and documenting classes. It is
+not unlike other UML design tools except for four major differences:
+ * Strict focus on class modeling: UML as a whole does a lot of things that
+ I never really found a use for. I am only interested in class and
+ inheritence modeling and documentation. I don't like having lots of
+ comments in my source, so I find it nicer to have the docs in the class
+ model.
+ * Code generation: I think there are some UML tools out there that do this,
+ but they tend to generate it with lots of special comments that tell the
+ tool where things are and how to re-write the files and all that. The
+ KlassModeler writes headers that I find clean and easy to read.
+ * Reads existing headers: You can point it to a header file and it will
+ read it in and create a class diagram. You can use this functionality to
+ import existing projects into KlassModeler.
+ * HTML doc generation: It spits out a set of HTML pages that puts all your
+ documentation in an easy to read format that can be used with any web
+ browser. A very big plus for helping other people understand your code.
+
+WWW: http://www.jameswells.net/KlassModeler/