[aravis] documentation: more improvements to the utility help.



commit 6d9d60a461e7c8af6cc8b374a5a0fc38940266d1
Author: Emmanuel Pacaud <emmanuel gnome org>
Date:   Mon Jun 20 17:02:10 2011 +0200

    documentation: more improvements to the utility help.

 src/arvcontrol.c      |    2 +-
 src/arvfakegvcamera.c |    6 ++++--
 src/arvshowdevices.c  |   13 +++++++------
 3 files changed, 12 insertions(+), 9 deletions(-)
---
diff --git a/src/arvcontrol.c b/src/arvcontrol.c
index 4122b34..4ee17b6 100644
--- a/src/arvcontrol.c
+++ b/src/arvcontrol.c
@@ -16,7 +16,7 @@ static const GOptionEntry arv_option_entries[] =
 	{ "description",	'i', 0, G_OPTION_ARG_NONE,
 		&arv_option_show_description,	"Show feature description", NULL},
 	{ "debug", 		'd', 0, G_OPTION_ARG_STRING,
-		&arv_option_debug_domains, 	"Debug", "domain[:level][,domain:[level]]..." },
+		&arv_option_debug_domains, 	NULL, "category[:level][,...]" },
 	{ NULL }
 };
 
diff --git a/src/arvfakegvcamera.c b/src/arvfakegvcamera.c
index 492962a..a2a0555 100644
--- a/src/arvfakegvcamera.c
+++ b/src/arvfakegvcamera.c
@@ -442,9 +442,9 @@ static char *arv_option_debug_domains = NULL;
 static const GOptionEntry arv_option_entries[] =
 {
 	{ "interface",		'i', 0, G_OPTION_ARG_STRING,
-		&arv_option_interface_name,	"Listening interface name", NULL},
+		&arv_option_interface_name,	"Listening interface name", "interface_id"},
 	{ "debug", 		'd', 0, G_OPTION_ARG_STRING,
-		&arv_option_debug_domains, 	"Debug mode", NULL },
+		&arv_option_debug_domains, 	NULL, "category[:level][,...]" },
 	{ NULL }
 };
 
@@ -461,6 +461,8 @@ main (int argc, char **argv)
 	g_type_init ();
 
 	context = g_option_context_new (NULL);
+	g_option_context_set_summary (context, "Fake GigEVision camera.");
+	g_option_context_set_description (context, "Example: 'arv-fake-gv-camera-" ARAVIS_API_VERSION " -i eth0'");
 	g_option_context_add_main_entries (context, arv_option_entries, NULL);
 
 	if (!g_option_context_parse (context, &argc, &argv, &error)) {
diff --git a/src/arvshowdevices.c b/src/arvshowdevices.c
index 9a4736e..5eb56d8 100644
--- a/src/arvshowdevices.c
+++ b/src/arvshowdevices.c
@@ -2,18 +2,18 @@
 #include <stdlib.h>
 #include <stdio.h>
 
-static char *arv_option_camera_name = NULL;
+static char *arv_option_device_name = NULL;
 static gboolean arv_option_show_xml = FALSE;
 static char *arv_option_debug_domains = NULL;
 
 static const GOptionEntry arv_option_entries[] =
 {
 	{ "name",		'n', 0, G_OPTION_ARG_STRING,
-		&arv_option_camera_name,"Camera name", NULL},
+		&arv_option_device_name,	NULL, "device_name"},
 	{ "xml",		'x', 0, G_OPTION_ARG_NONE,
-		&arv_option_show_xml,	"Show XML", NULL},
+		&arv_option_show_xml,		"Show Genicam data", NULL},
 	{ "debug", 		'd', 0, G_OPTION_ARG_STRING,
-		&arv_option_debug_domains, 	"Debug domains", NULL },
+		&arv_option_debug_domains, 	NULL, "category[:level][,...]" },
 	{ NULL }
 };
 
@@ -28,6 +28,7 @@ main (int argc, char **argv)
 	g_type_init ();
 
 	context = g_option_context_new (NULL);
+	g_option_context_set_summary (context, "Utility that gives the list of the connected devices.");
 	g_option_context_add_main_entries (context, arv_option_entries, NULL);
 
 	if (!g_option_context_parse (context, &argc, &argv, &error)) {
@@ -52,8 +53,8 @@ main (int argc, char **argv)
 			const char *device_id;
 
 			device_id = arv_get_device_id (i);
-			if (arv_option_camera_name == NULL ||
-			    g_strcmp0 (device_id, arv_option_camera_name) == 0) {
+			if (arv_option_device_name == NULL ||
+			    g_strcmp0 (device_id, arv_option_device_name) == 0) {
 				if (device_id != NULL)
 					printf ("%s\n",  device_id);
 



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]