Cleanup comments and API docs.

scantailor · Apr 3, 2010 · 34d0cdd · 34d0cdd
1 parent 7818b49
commit 34d0cdd
Show file tree

Hide file tree

Showing 10 changed files with 25 additions and 23 deletions.
diff --git a/Despeckle.cpp b/Despeckle.cpp
@@ -1,6 +1,6 @@
 /*
     Scan Tailor - Interactive post-processing tool for scanned pages.
-    Copyright (C)  Joseph Artsimovich <joseph.artsimovich@mail.ru>
+	Copyright (C)  Joseph Artsimovich <joseph.artsimovich@gmail.com>
 
     This program is free software: you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by

diff --git a/Despeckle.h b/Despeckle.h
@@ -37,13 +37,10 @@ class Despeckle
 	 * \brief Removes small speckles from a binary image.
 	 *
 	 * \param src The image to despeckle.  Must not be null.
-	 * \param big_object_threshold The number of pixels which indicates
-	 *        the object having them is definitely not a speckle.
-	 *        Objects that have less pixels may or may not be considered
-	 *        as speckles, but if all objects consist of less pixels
-	 *        then this threshold, all of them will be considered as speckles
-	 *        and be removed.
+	 * \param dpi DPI of \p src.
+	 * \param level Despeckling aggressiveness.
 	 * \param dbg An optional sink for debugging images.
+	 * \param status For asynchronous task cancellation.
 	 * \return The despeckled image.
 	 */
 	static imageproc::BinaryImage despeckle(

diff --git a/Doxyfile b/Doxyfile
@@ -28,7 +28,6 @@ STRIP_FROM_INC_PATH    =
 SHORT_NAMES            = NO
 JAVADOC_AUTOBRIEF      = NO
 MULTILINE_CPP_IS_BRIEF = NO
-DETAILS_AT_TOP         = NO
 INHERIT_DOCS           = YES
 SEPARATE_MEMBER_PAGES  = NO
 TAB_SIZE               = 8
@@ -228,7 +227,8 @@ EXPAND_ONLY_PREDEF     = NO
 SEARCH_INCLUDES        = YES
 INCLUDE_PATH           = foundation
 INCLUDE_FILE_PATTERNS  = 
-PREDEFINED             = 
+PREDEFINED             = DECLARE_NON_COPYABLE(x)= \
+                         Q_DECLARE_TR_FUNCTIONS(x)=
 EXPAND_AS_DEFINED      = 
 SKIP_FUNCTION_MACROS   = NO
 #---------------------------------------------------------------------------

diff --git a/ImageViewBase.cpp b/ImageViewBase.cpp
@@ -839,6 +839,8 @@ ImageViewBase::setNewWidgetFP(QPointF const widget_fp, bool const update)
  * direction.
  *
  * \param proposed_widget_fp The proposed value for m_widgetFocalPoint.
+ * \param update Whether to call this->update() in case the focal point
+ *        has changed.
  */
 void
 ImageViewBase::adjustAndSetNewWidgetFP(

diff --git a/ImageViewBase.h b/ImageViewBase.h
@@ -1,6 +1,6 @@
 /*
     Scan Tailor - Interactive post-processing tool for scanned pages.
-    Copyright (C) 2007-2009  Joseph Artsimovich <joseph_a@mail.ru>
+	Copyright (C)  Joseph Artsimovich <joseph.artsimovich@gmail.com>
 
     This program is free software: you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
@@ -73,7 +73,7 @@ class ImageViewBase : public QAbstractScrollArea
 	 *        to speed up real-time rendering of high-resolution
 	 *        images.  Note that the delayed high quality transform
 	 *        operates on the original image, not the downscaled one.
-	 * \param image_presentation Specifies transformation from image
+	 * \param presentation Specifies transformation from image
 	 *        pixel coordinates to virtual image coordinates, along
 	 *        with some other properties.
 	 * \param margins Reserve extra space near the widget borders.

diff --git a/filters/output/DespeckleVisualization.h b/filters/output/DespeckleVisualization.h
@@ -41,8 +41,8 @@ class DespeckleVisualization
 	DespeckleVisualization() {}
 
 	/**
-	 * \param pre_despeckle_image Image before despeckling.
-	 *        If this one is null, this object will be null as well.
+	 * \param output The output file, as produced by OutputGenerator::process().
+	 *        If this one is null, the visualization will be null as well.
 	 * \param speckles Speckles detected in the image.
 	 *        If this one is null, it is considered no speckles were detected.
 	 * \param dpi Dots-per-inch of both images.

diff --git a/filters/output/Params.h b/filters/output/Params.h
@@ -1,6 +1,6 @@
 /*
     Scan Tailor - Interactive post-processing tool for scanned pages.
-    Copyright (C)  Joseph Artsimovich <joseph.artsimovich@mail.ru>
+	Copyright (C)  Joseph Artsimovich <joseph.artsimovich@gmail.com>
 
     This program is free software: you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by

diff --git a/imageproc/LM.h b/imageproc/LM.h
@@ -86,14 +86,17 @@ class LM
 	 * NOT the value and gradient of E with respect to a!
 	 *
 	 * \param npts The number of data points.
-	 * \param x array of domain points, each may be multidimensional
-	 * \param y corresponding array of values
-	 * \param a the parameters/state of the model
-	 * \param vary false to indicate the corresponding a[k] is to be held fixed
-	 * \param lambda blend between steepest descent (lambda high) and
+	 * \param x Array of domain points, each may be multidimensional.
+	 * \param x_stride Distance in \p x from one point to another.
+	 * \param y Corresponding array of values.
+	 * \param a The parameters/state of the model.
+	 * \param s Sigma for point i.
+	 * \param vary False to indicate the corresponding a[k] is to be held fixed.
+	 * \param f The function to fit.
+	 * \param lambda Blend between steepest descent (lambda high) and
 	 *	      jump to bottom of quadratic (lambda zero). Start with 0.001.
-	 * \param termepsilon termination accuracy (0.01)
-	 * \param maxiter	stop and return after this many iterations if not done
+	 * \param termepsilon Termination accuracy (0.01).
+	 * \param maxiter Stop and return after this many iterations if not done.
 	 *
 	 * \return the new lambda for future iterations.
 	 *  Can use this and maxiter to interleave the LM descent with some other

diff --git a/zones/ZoneContextMenuInteraction.h b/zones/ZoneContextMenuInteraction.h
@@ -41,7 +41,7 @@ class ZoneContextMenuInteraction : public QObject, public InteractionHandler
 	Q_OBJECT
 public:
 	/**
-	 * \node This factory method will return null if there are no zones
+	 * \note This factory method will return null if there are no zones
 	 *       under the mouse pointer.
 	 */
 	static ZoneContextMenuInteraction* create(

diff --git a/zones/ZoneInteractionContext.h b/zones/ZoneInteractionContext.h
@@ -90,7 +90,7 @@ class ZoneInteractionContext
 	}
 
 	/**
-	 * \node This function may refuse to create a context menu interaction by returning null.
+	 * \note This function may refuse to create a context menu interaction by returning null.
 	 */
 	virtual InteractionHandler* createContextMenuInteraction(InteractionState& interaction) {
 		return m_contextMenuInteractionCreator(interaction);