gst: Annotate various strings as type filename if they represent a path/filename

This commit is contained in:
Sebastian Dröge 2017-12-03 14:48:22 +02:00
parent e6dbbb3854
commit 464f840a23
3 changed files with 5 additions and 5 deletions

View file

@ -822,7 +822,7 @@ gst_debug_bin_to_dot_data (GstBin * bin, GstDebugGraphDetails details)
/* /*
* gst_debug_bin_to_dot_file: * gst_debug_bin_to_dot_file:
* @bin: the top-level pipeline that should be analyzed * @bin: the top-level pipeline that should be analyzed
* @file_name: output base filename (e.g. "myplayer") * @file_name: (type filename): output base filename (e.g. "myplayer")
* *
* To aid debugging applications one can use this method to write out the whole * To aid debugging applications one can use this method to write out the whole
* network of gstreamer elements that form the pipeline into an dot file. * network of gstreamer elements that form the pipeline into an dot file.
@ -872,7 +872,7 @@ gst_debug_bin_to_dot_file (GstBin * bin, GstDebugGraphDetails details,
/* /*
* gst_debug_bin_to_dot_file_with_ts: * gst_debug_bin_to_dot_file_with_ts:
* @bin: the top-level pipeline that should be analyzed * @bin: the top-level pipeline that should be analyzed
* @file_name: output base filename (e.g. "myplayer") * @file_name: (type filename): output base filename (e.g. "myplayer")
* *
* This works like gst_debug_bin_to_dot_file(), but adds the current timestamp * This works like gst_debug_bin_to_dot_file(), but adds the current timestamp
* to the filename, so that it can be used to take multiple snapshots. * to the filename, so that it can be used to take multiple snapshots.

View file

@ -667,7 +667,7 @@ static GMutex gst_plugin_loading_mutex;
/** /**
* gst_plugin_load_file: * gst_plugin_load_file:
* @filename: the plugin filename to load * @filename: (type filename): the plugin filename to load
* @error: pointer to a %NULL-valued GError * @error: pointer to a %NULL-valued GError
* *
* Loads the given plugin and refs it. Caller needs to unref after use. * Loads the given plugin and refs it. Caller needs to unref after use.
@ -971,7 +971,7 @@ gst_plugin_get_description (GstPlugin * plugin)
* *
* get the filename of the plugin * get the filename of the plugin
* *
* Returns: the filename of the plugin * Returns: (type filename): the filename of the plugin
*/ */
const gchar * const gchar *
gst_plugin_get_filename (GstPlugin * plugin) gst_plugin_get_filename (GstPlugin * plugin)

View file

@ -1375,7 +1375,7 @@ gst_registry_scan_path_internal (GstRegistryScanContext * context,
/** /**
* gst_registry_scan_path: * gst_registry_scan_path:
* @registry: the registry to add found plugins to * @registry: the registry to add found plugins to
* @path: the path to scan * @path: (type filename): the path to scan
* *
* Scan the given path for plugins to add to the registry. The syntax of the * Scan the given path for plugins to add to the registry. The syntax of the
* path is specific to the registry. * path is specific to the registry.