diff options
| author | Stefan Kost <ensonic@users.sf.net> | 2009-01-28 12:29:42 +0200 |
|---|---|---|
| committer | Stefan Kost <ensonic@users.sf.net> | 2009-01-28 12:32:59 +0200 |
| commit | a99d3f8769ed3fd1266d5216ecefebfd1bdcf663 (patch) | |
| tree | 4a5cf5e0f2f44b1f9ccea5344c38ef98f0a92990 /gst/videocrop | |
| parent | 00fdca0c14eb9a5fe6b8b9f2d5ce2313e3b32f23 (diff) | |
Update and add documentation for plugins with no deps (gst).
Link to properties. Correct titles for examples. Document a few trivial cases. Keep lists in section file and docs/plugins/Makefile.am alphabetically ordered.
Diffstat (limited to 'gst/videocrop')
| -rw-r--r-- | gst/videocrop/gstaspectratiocrop.c | 10 | ||||
| -rw-r--r-- | gst/videocrop/gstvideocrop.c | 26 |
2 files changed, 16 insertions, 20 deletions
diff --git a/gst/videocrop/gstaspectratiocrop.c b/gst/videocrop/gstaspectratiocrop.c index 28ca397b..cd59323a 100644 --- a/gst/videocrop/gstaspectratiocrop.c +++ b/gst/videocrop/gstaspectratiocrop.c @@ -21,14 +21,16 @@ * SECTION:element-aspectratiocrop * @see_also: #GstVideoCrop * - * This element crops video frames to a specified aspect-ratio. + * This element crops video frames to a specified #GstAspectRatioCrop:aspect-ratio. * - * If the aspect-ratio is already correct, the element will operate in pass-through mode. + * If the aspect-ratio is already correct, the element will operate + * in pass-through mode. * * <refsect2> * <title>Example launch line</title> - * |[gst-launch -v videotestsrc ! video/x-raw-rgb,height=640,width=480 ! aspectratiocrop aspect-ratio=16/9 ! ximagesink]| - * This pipeline generates a videostream in 4/3 and crops it to 16/9. + * |[ + * gst-launch -v videotestsrc ! video/x-raw-rgb,height=640,width=480 ! aspectratiocrop aspect-ratio=16/9 ! ximagesink + * ]| This pipeline generates a videostream in 4/3 and crops it to 16/9. * </refsect2> */ diff --git a/gst/videocrop/gstvideocrop.c b/gst/videocrop/gstvideocrop.c index 0d0ebfed..607d9248 100644 --- a/gst/videocrop/gstvideocrop.c +++ b/gst/videocrop/gstvideocrop.c @@ -21,35 +21,29 @@ * SECTION:element-videocrop * @see_also: #GstVideoBox * - * <refsect2> - * <para> * This element crops video frames, meaning it can remove parts of the * picture on the left, right, top or bottom of the picture and output * a smaller picture than the input picture, with the unwanted parts at the * border removed. - * </para> - * <para> + * * The videocrop element is similar to the videobox element, but its main * goal is to support a multitude of formats as efficiently as possible. * Unlike videbox, it cannot add borders to the picture and unlike videbox * it will always output images in exactly the same format as the input image. - * </para> - * <para> + * * If there is nothing to crop, the element will operate in pass-through mode. - * </para> - * <para> + * * Note that no special efforts are made to handle chroma-subsampled formats * in the case of odd-valued cropping and compensate for sub-unit chroma plane - * shifts for such formats in the case where the "left" or "top" property is - * set to an odd number. This doesn't matter for most use cases, but it might - * matter for yours. - * </para> + * shifts for such formats in the case where the #GstVideoCrop:left or + * #GstVideoCrop:top property is set to an odd number. This doesn't matter for + * most use cases, but it might matter for yours. + * + * <refsect2> * <title>Example launch line</title> - * <para> - * <programlisting> + * |[ * gst-launch -v videotestsrc ! videocrop top=42 left=1 right=4 bottom=0 ! ximagesink - * </programlisting> - * </para> + * ]| * </refsect2> */ |