From: Nikita Kitaev <nikitakit@gmail.com>
Date: Tue, 15 Jun 2010 21:26:58 +0000 (-0700)
Subject: Documentation
X-Git-Url: https://git.pterodactylus.net/?p=synfig.git;a=commitdiff_plain;h=f9108d43098568819a416d1496ac9e12528de39e

Documentation
---

diff --git a/synfig-studio/src/gui/duck.h b/synfig-studio/src/gui/duck.h
index 9a054f3..fb96c45 100644
--- a/synfig-studio/src/gui/duck.h
+++ b/synfig-studio/src/gui/duck.h
@@ -197,10 +197,10 @@ public:
 
 	const synfig::TransformStack& get_transform_stack()const { return transform_stack_; }
 
-	//! \writeme
+	//! Sets the type of duck
 	void set_type(Type x) { type_=x; }
 
-	//! \writeme
+	//! Gets the type of duck
 	Type get_type()const { return type_; }
 
 	//! Sets the scalar multiplier for the duck with respect to the origin
@@ -217,7 +217,13 @@ public:
 	//! Returns the location of the duck
 	synfig::Point get_point()const { return shared_point?*shared_point:point; }
 
+	//! Returns the rotations of the duck
+	/*! For angle and tangent ducks, rotations are used instead of the location
+	 *  so that the duck can me rotated more than 180 degrees
+	 */
 	synfig::Angle get_rotations()const { return rotations; };
+	
+	//! Sets the rotations of the duck
 	void set_rotations(const synfig::Angle &x) { rotations=x; };
 
 	synfig::Point get_trans_point()const;
diff --git a/synfig-studio/src/gui/duckmatic.cpp b/synfig-studio/src/gui/duckmatic.cpp
index 786aa11..51ed17f 100644
--- a/synfig-studio/src/gui/duckmatic.cpp
+++ b/synfig-studio/src/gui/duckmatic.cpp
@@ -125,7 +125,7 @@ Duckmatic::clear_ducks()
 		stroke_list_=persistent_stroke_list_;
 }
 
-//! Returns \a true if the given duck is currently selected
+
 bool
 Duckmatic::duck_is_selected(const etl::handle<Duck> &duck)const
 {
diff --git a/synfig-studio/src/gui/duckmatic.h b/synfig-studio/src/gui/duckmatic.h
index e10db0c..68e4671 100644
--- a/synfig-studio/src/gui/duckmatic.h
+++ b/synfig-studio/src/gui/duckmatic.h
@@ -118,7 +118,6 @@ public:
 **	the work area that the user may want to interact with.
 **	This includes ducks, beziers, and strokes
 **
-**	\note At some point I'll probably rename this class to "DuckOMatic".
 */
 class Duckmatic
 {
@@ -322,13 +321,27 @@ public:
 
 	void unselect_duck(const etl::handle<Duck> &duck);
 
+	//! Begin dragging ducks
+	/*! \param offset Canvas coordinates of the mouse when the drag began */
 	void start_duck_drag(const synfig::Vector& offset);
+
+	//! Continue dragging the selected ducks
+	/*! The overall vector of the drag is vector-offset
+	 *  (where offset was given in start_duck_drag)
+	 *  \param vector Canvas coordinates of the mouse at this moment */
 	void translate_selected_ducks(const synfig::Vector& vector);
+
+	//! Update the coordinates of tangents and linked-to-bline ducks
 	void update_ducks();
+
+	//! Ends the duck drag
 	bool end_duck_drag();
 
+	//! Calls all of the ducks' edited signals
+	/*! Updates corresponding valuenodes after a drag */
 	void signal_edited_selected_ducks();
 
+	//! Signals to each selected duck that it has been clicked
 	void signal_user_click_selected_ducks(int button);
 
 
@@ -375,10 +388,10 @@ public:
 
 	bool add_to_ducks(const synfigapp::ValueDesc& value_desc,etl::handle<CanvasView> canvas_view, const synfig::TransformStack& transform_stack_, synfig::ParamDesc *param_desc=0, int multiple=0);
 
-	//! \writeme
+	//! Set the type mask, which determines what types of ducks are shown
 	void set_type_mask(Type x) { type_mask=x; }
 
-	//! \writeme
+	//! Get the type mask, which determines what types of ducks are shown
 	Type get_type_mask()const { return type_mask; }
 
 	void select_all_ducks();