[vlc-devel] [PATCH] invmem - add short help

[Robert Paciorek]

add set_help() with short information about usage in libvlc
---
 modules/codec/invmem.c |    7 +++++++
 1 files changed, 7 insertions(+), 0 deletions(-)

diff --git a/modules/codec/invmem.c b/modules/codec/invmem.c
index a02bdbb..4d7220f 100644
--- a/modules/codec/invmem.c
+++ b/modules/codec/invmem.c
@@ -68,11 +68,18 @@ static picture_t *DecodeBlock  ( decoder_t *, block_t ** );
 #define T_DATA N_( "Callback data" )
 #define LT_DATA N_( "Data for the locking and unlocking functions" )
 
+#define INVMEM_HELP N_( "This module make possible making video stream from raw-image " \
+                        "generating (to memory) from rendering program uses libvlc. " \
+                        "To use this module from libvlc set --codec to invmem, "\
+                        "set all --invmem-* options in vlc_argv an use " \
+                        "libvlc_media_new(libvlc, \"fake://\", &ex);. " \
+                        "Besides is simillar to vmem video output module." )
 vlc_module_begin();
     set_category( CAT_INPUT );
     set_subcategory( SUBCAT_INPUT_VCODEC );
     set_shortname( N_("Memory video decoder") );
     set_description( N_("Memory video decoder") );
+    set_help( INVMEM_HELP );
     set_capability( "decoder", 1000 );
     set_callbacks( OpenDecoder, CloseDecoder );
     add_shortcut( "invmem" );
-- 
1.5.6.5