Fix remaining doxygen warnings (!)

3 files changed, 18 insertions, 14 deletions

diff --git a/libs/canvas/canvas/canvas.h b/libs/canvas/canvas/canvas.h
index b7060e60c0..7733f07a95 100644
--- a/libs/canvas/canvas/canvas.h
+++ b/libs/canvas/canvas/canvas.h
@@ -135,7 +135,7 @@ public:
 	virtual Coord height () const = 0;
 
 	/** Store the coordinates of the mouse pointer in window coordinates in
-	 * @param winpos. Return true if the position was within the window,
+	 * \p winpos . Return true if the position was within the window,
 	 * false otherwise.
 	 */
 	virtual bool get_mouse_position (Duple& winpos) const = 0;
@@ -147,9 +147,9 @@ public:
 
 	sigc::signal<void> PreRender;
 
-	/** Ensures that the position given by @param winpos (in window
+	/** Ensures that the position given by \p winpos (in window
 	 * coordinates) is within the current window area, possibly reduced by
-	 * @param border.
+	 * \p border.
 	 */
 	Duple clamp_to_window (Duple const& winpos, Duple border = Duple());
 
diff --git a/libs/canvas/canvas/interpolated_curve.h b/libs/canvas/canvas/interpolated_curve.h
index 2faf70dde6..3a8706a6bf 100644
--- a/libs/canvas/canvas/interpolated_curve.h
+++ b/libs/canvas/canvas/interpolated_curve.h
@@ -36,7 +36,7 @@ protected:
 
 	/**
 	 * This method will calculate the Catmull-Rom interpolation curve, returning
-	 * it as a list of Coord coordinate objects.  This method in particular
+	 * it as a list of Coord coordinate objects. This method in particular
 	 * adds the first and last control points which are not visible, but required
 	 * for calculating the spline.
 	 *
@@ -47,6 +47,8 @@ protected:
 	 * point will depend on the spacing between the control points.
 	 * @return The list of interpolated coordinates.
 	 * @param curve_type Chordal (stiff), Uniform(floppy), or Centripetal(medium)
+	 * @param closed Specify if the shape is open or closed
+	 * @param results List of calculated coordinates
 	 * @throws gov.ca.water.shapelite.analysis.CatmullRomException if
 	 * points_per_segment is less than 2.
 	 */
@@ -176,7 +178,7 @@ private:
 	 * or centripetal curve types. Uniform can produce loops, chordal can
 	 * produce large distortions from the original lines, and centripetal is an
 	 * optimal balance without spaces.
-	 * @return the list of coordinates that define the CatmullRom curve
+	 * @param results List of calculated coordinates that define the CatmullRom curve
 	 * between the points defined by index+1 and index+2.
 	 */
 	static void
diff --git a/libs/canvas/canvas/item.h b/libs/canvas/canvas/item.h
index e71419e30c..d9d644abe1 100644
--- a/libs/canvas/canvas/item.h
+++ b/libs/canvas/canvas/item.h
@@ -83,22 +83,23 @@ public:
 	 */
 	virtual void prepare_for_render (Rect const & area) const { }
 
-	/** Adds one or more items to the vector @param items based on their
-	 * covering @param point which is in **window** coordinates
+	/** Adds one or more items to the vector \p items based on their
+	 * covering \p point which is in window coordinates
 	 *
 	 * Note that Item::add_items_at_window_point() is only intended to be
 	 * called on items already looked up in a LookupTable (i.e. by a
-	 * parent) and thus known to cover @param point already.
+	 * parent) and thus known to cover \p point already.
 	 *
 	 * Derived classes may add more items than themselves (e.g. containers).
 	 */
-	virtual void add_items_at_point (Duple /*point*/, std::vector<Item const *>& items) const;
+	virtual void add_items_at_point (Duple point, std::vector<Item const *>& items) const;
 
-	/** Return true if the item covers @param point, false otherwise.
+	/** Test if point is inside the item
 	 *
-	 * The point is in window coordinates
+	 * @param point The point is in window coordinates
+	 * @return true if the item covers \p point , false otherwise.
 	 */
-	virtual bool covers (Duple const &) const;
+	virtual bool covers (Duple const& point) const;
 
 	/** Update _bounding_box and _bounding_box_dirty */
 	virtual void compute_bounding_box () const = 0;
@@ -118,13 +119,14 @@ public:
 	const Item* closest_ancestor_with (const Item& other) const;
 	bool common_ancestor_within (uint32_t, const Item& other) const;
 
-	/** returns true if this item is an ancestor of @param candidate,
+	/** returns true if this item is an ancestor of \p candidate ,
 	 * and false otherwise.
 	 */
 	bool is_ancestor_of (const Item& candidate) const {
 		return candidate.is_descendant_of (*this);
 	}
-	/** returns true if this Item is a descendant of @param candidate,
+
+	/** returns true if this Item is a descendant of \p candidate ,
 	 * and false otherwise.
 	 */
 	bool is_descendant_of (const Item& candidate) const;