docs: Add some more docs about editing mode

Also add the documentation "Section" into ges-enum.c so the file documentation ar
 actualy taken into account in the final generated documentation.

diff --git a/ges/ges-enums.c b/ges/ges-enums.c
index a64b8af101bfb6e71c7bd6a1d6bd608007add107..c3bc10b9c3e93fa850caa6a10c3f16dbf8e080ad 100644 (file)
--- a/ges/ges-enums.c
+++ b/ges/ges-enums.c
@@ -18,6 +18,11 @@
  * Boston, MA 02111-1307, USA.
  */
 
+/**
+ * SECTION:ges-enums
+ * @short_description: Various enums for the Gstreamer Editing Services
+ */
+
 #include "ges-enums.h"
 
 #define C_ENUM(v) ((guint) v)

diff --git a/ges/ges-enums.h b/ges/ges-enums.h
index 64fc86649ae8cf18e5647f1b637b8d0da375dad3..bd61bf56c29782d3944a661804cb9ad560a29eb0 100644 (file)
--- a/ges/ges-enums.h
+++ b/ges/ges-enums.h
@@ -329,22 +329,32 @@ GType ges_pipeline_flags_get_type (void);
  * @GES_EDIT_MODE_RIPPLE: The objects are edited in ripple mode.
  *  The Ripple mode allows you to modify the beginning/end of a clip
  *  and move the neighbours accordingly. This will change the overall
- *  timeline duration.
+ *  timeline duration. In the case of ripple end, the duration of the
+ *  clip being rippled can't be supperior to it max-duration - inpoint
+ *  and if it would be the case, nothing wil happen.
  * @GES_EDIT_MODE_ROLL: The object is edited in roll mode.
  *  The Roll mode allows you to modify the position of an editing point
  *  between two clips without modifying the inpoint of the first clip
  *  nor the out-point of the second clip. This will not change the
- *  overall timeline duration.
+ *  overall timeline duration. In the case of ripple end, the duration of the
+ *  clip being rolled can't be supperior to it max-duration - inpoint and if
+ *  it would be the case, nothing wil happen.
  * @GES_EDIT_MODE_TRIM: The object is edited in trim mode.
  *  The Trim mode allows you to modify the in-point/out-point of a clip without
- *  modifying it's duration or position in the timeline.
+ *  modifying it's duration or position in the timeline. A clip being trim
  * @GES_EDIT_MODE_SLIDE: The object is edited in slide mode.
  *  The Slide mode allows you to modify the position of a clip in a
  *  timeline without modifying it's duration or it's in-point, but will
  *  modify the out-point of the previous clip and in-point of the
  *  following clip so as not to modify the overall timeline duration.
+ *  (not implemented yet)
  *
- * The various edition modes the a clip can be edited with.
+ * The various edition modes a clip can be edited with.
+ *
+ *
+ * You can also find more explanation about the behaviour of those modes at:
+ * <ulink url="http://pitivi.org/manual/trimming.html"> trim, ripple and roll</ulink>
+ * and <ulink url="http://pitivi.org/manual/usingclips.html">clip management</ulink>.
  */
 typedef enum {
     GES_EDIT_MODE_NORMAL,