]> git.street.me.uk Git - andy/viking.git/commitdiff
[DOC] Improve aquire's reference documentation
authorGuilhem Bonnefille <guilhem.bonnefille@gmail.com>
Wed, 9 Jan 2013 21:48:01 +0000 (22:48 +0100)
committerGuilhem Bonnefille <guilhem.bonnefille@gmail.com>
Wed, 9 Jan 2013 21:48:01 +0000 (22:48 +0100)
src/acquire.h

index e5fffb1051afe5183cc65a401e51aad70456431d..dd419c01fb94a6b8a811a7ddd13209e48f250d05 100644 (file)
@@ -98,6 +98,10 @@ typedef void (*VikDataSourceGetCmdStringFuncWithInputInput) ( gpointer user_data
 
 /**
  * VikDataSourceProcessFunc:
+ * @vtl:
+ * @cmd: the arguments computed by #VikDataSourceInterface.get_cmd_string_func
+ * @extra: the extra arguments computed by #VikDataSourceInterface.get_cmd_string_func
+ * @status_cb: the #VikDataSourceInterface.progress_func
  * 
  * The actual function to do stuff - must report success/failure.
  */
@@ -122,6 +126,11 @@ typedef void (*VikDataSourceCleanupFunc) ( gpointer user_data );
 
 typedef void (*VikDataSourceOffFunc) ( gpointer user_data, gchar **babelargs_or_shellcmd, gchar **inputfile_or_inputtype );;
 
+/**
+ * VikDataSourceInterface:
+ * 
+ * Main interface.
+ */
 struct _VikDataSourceInterface {
   const gchar *window_title;
   const gchar *layer_title;