From: 020535 <020535@07accd87-1e0b-0410-939d-c05d8a058e03>
Date: Thu, 11 Jun 2009 22:26:07 +0000 (+0000)
Subject: Corrections to documentation
X-Git-Url: https://git.defcon.no/?a=commitdiff_plain;h=1bf2e5abcce5bc20773a0bda4c9a5f17ffcc46f9;p=qopencamwidget

Corrections to documentation

git-svn-id: https://dilbert.hig.no/svn/student/020535/qopencamwidget/trunk@178 07accd87-1e0b-0410-939d-c05d8a058e03
---

diff --git a/qopencamwidget.cpp b/qopencamwidget.cpp
index e5358f5..539b4d5 100644
--- a/qopencamwidget.cpp
+++ b/qopencamwidget.cpp
@@ -36,12 +36,18 @@
  * This class solves the complexity of adding a webcam view,
  * by using the cross-platform available OpenCV library.
  *
- * Limitations, i.e. reasons to read this code and reimplement,
- * are: saving or streaming video is not really available (unless
- * you do repeated timer-triggered connections to the startSnap slot),
- * the widget size is identical to the video source dimensions (it
- * resizes the wodget using setMinimuSize to the video dimensions,
- * and does not handle resizing to sizes above this dimension.
+ * Limitations, i.e. reasons to read this code and reimplement, are: 
+ *
+ * \li saving or streaming video is not really available (unless you do 
+ *     repeated timer-triggered connections to the startSnap slot).
+ * \li this is a crude and simple implementation, created to solve
+ *     the problem of creating a "view-and-shoot" camera app.
+ *     If your needs are more complex than that, read the code,
+ *     and reimplement.
+ *
+ * Note that even tough the main file here totals some ~250 lines,
+ * only about 90 of those are actual code lines, and and even those
+ * contain a lot of "air"...
  *
  * A brief summary of how to use this class:
  * \code