diff options
| author | Stefan Kost <ensonic@users.sf.net> | 2009-07-13 21:54:47 +0300 |
|---|---|---|
| committer | Stefan Kost <ensonic@users.sf.net> | 2009-07-13 21:54:47 +0300 |
| commit | cae6a55ba31948db63bed40f8568f294f794af6d (patch) | |
| tree | d6f5536425df3844e77e4a09de3138830bade05d | |
| parent | d06520f4a828d1a8f39b99ffd9097672d41000bd (diff) | |
navigation: simplify docs
Make short-desc short - its used in the toc. Strip uneeded markup.
| -rw-r--r-- | gst-libs/gst/interfaces/navigation.c | 12 |
1 files changed, 3 insertions, 9 deletions
diff --git a/gst-libs/gst/interfaces/navigation.c b/gst-libs/gst/interfaces/navigation.c index f07dcc7ec..cd4aa80e0 100644 --- a/gst-libs/gst/interfaces/navigation.c +++ b/gst-libs/gst/interfaces/navigation.c @@ -23,17 +23,13 @@ /** * SECTION:gstnavigation * @short_description: Interface for creating, sending and parsing navigation - * events. Navigation events are used for conveying mouse movement, button clicks, - * key presses and specific commands such as DVD menu navigation. + * events. * - * <refsect2> - * <para> * The Navigation interface is used for creating and injecting navigation related * events such as mouse button presses, cursor motion and key presses. The associated * library also provides methods for parsing received events, and for sending and - * receiving navigation related bus events. - * </para> - * <para> + * receiving navigation related bus events. One main usecase is DVD menu navigation. + * * The main parts of the API are: * <itemizedlist> * <listitem> @@ -61,8 +57,6 @@ * </para> * </listitem> * </itemizedlist> - * </para> - * </refsect2> */ #ifdef HAVE_CONFIG_H |