[geany/geany] bfa094: doxygen: various doxygen-related fixes in preparation for gtkdoc generation
Thomas Martitz
git-noreply at xxxxx
Tue Mar 1 19:40:03 UTC 2016
Branch: refs/heads/master
Author: Thomas Martitz <kugel at rockbox.org>
Committer: Thomas Martitz <kugel at rockbox.org>
Date: Sun, 07 Feb 2016 16:50:23 UTC
Commit: bfa0946420d49a23caeec17af21c95b11de5a5fe
https://github.com/geany/geany/commit/bfa0946420d49a23caeec17af21c95b11de5a5fe
Log Message:
-----------
doxygen: various doxygen-related fixes in preparation for gtkdoc generation
Modified Paths:
--------------
doc/Doxyfile.in
doc/pluginsymbols.c
src/document.c
src/editor.c
src/editor.h
src/filetypes.c
src/filetypes.h
src/keybindings.c
src/plugindata.h
src/pluginutils.c
src/search.h
src/spawn.c
src/stash.c
src/ui_utils.c
src/utils.c
tagmanager/src/tm_workspace.c
Modified: doc/Doxyfile.in
13 lines changed, 12 insertions(+), 1 deletions(-)
===================================================================
@@ -247,7 +247,18 @@ ALIASES = "signal=- @ref " \
"endsignalproto=@endcode " \
"signaldesc=" \
"signals=@b Signals: " \
- "endsignals= "
+ "endsignals= " \
+ "addtogir=@internal"
+
+ALIASES += "transfer{1}=\a \xmlonly <simplesect kind=\"geany:transfer\">\1</simplesect>\endxmlonly \htmlonly (transfer: \1) \endhtmlonly"
+ALIASES += "elementtype{1}=\a \xmlonly <simplesect kind=\"geany:element-type\">\1</simplesect>\endxmlonly \htmlonly (element-type: \1) \endhtmlonly"
+ALIASES += "scope{1}=\a \xmlonly <simplesect kind=\"geany:scope\">\1</simplesect>\endxmlonly \htmlonly (scope: \1) \endhtmlonly"
+ALIASES += "skip=\a \xmlonly <simplesect kind=\"geany:skip\"></simplesect>\endxmlonly"
+ALIASES += "null=\a \xmlonly <simplesect kind=\"geany:nullable\"></simplesect>\endxmlonly"
+ALIASES += "cb=\a \xmlonly <simplesect kind=\"geany:cb\"></simplesect>\endxmlonly"
+ALIASES += "cbdata=\a \xmlonly <simplesect kind=\"geany:cbdata\"></simplesect>\endxmlonly"
+ALIASES += "cbfree=\a \xmlonly <simplesect kind=\"geany:cbfree\"></simplesect>\endxmlonly"
+
# This tag can be used to specify a number of word-keyword mappings (TCL only).
# A mapping has the form "name=value". For example adding "class=itcl::class"
Modified: doc/pluginsymbols.c
4 lines changed, 3 insertions(+), 1 deletions(-)
===================================================================
@@ -87,7 +87,9 @@ KeyBindingGroup *plugin_key_group;
* @param dialog The plugin preferences dialog widget - this should only be used to
* connect the @c "response" signal. If settings should be read from the dialog, the
* response will be either @c GTK_RESPONSE_OK or @c GTK_RESPONSE_APPLY.
- * @return A container widget holding preference widgets.
+ *
+ * @return @transfer{floating} A container widget holding preference widgets.
+ *
* @note Using @link stash.h Stash @endlink can make implementing preferences easier.
* @see plugin_configure_single(). */
GtkWidget *plugin_configure(GtkDialog *dialog);
Modified: src/document.c
18 lines changed, 9 insertions(+), 9 deletions(-)
===================================================================
@@ -146,7 +146,7 @@ static GtkWidget* document_show_message(GeanyDocument *doc, GtkMessageType msgty
* @param realname The filename to search, which should be identical to the
* string returned by @c tm_get_real_path().
*
- * @return The matching document, or @c NULL.
+ * @return @transfer{none} The matching document, or @c NULL.
* @note This is only really useful when passing a @c TMSourceFile::file_name.
* @see GeanyDocument::real_path.
* @see document_find_by_filename().
@@ -196,7 +196,7 @@ static gchar *get_real_path_from_utf8(const gchar *utf8_filename)
*
* @param utf8_filename The filename to search (in UTF-8 encoding).
*
- * @return The matching document, or @c NULL.
+ * @return @transfer{none} The matching document, or @c NULL.
* @see document_find_by_real_path().
**/
GEANY_API_SYMBOL
@@ -250,7 +250,7 @@ GeanyDocument *document_find_by_sci(ScintillaObject *sci)
* Useful when the corresponding document may have been closed since the
* ID was retrieved.
* @param id The ID of the document to find
- * @return @c NULL if the document is no longer open.
+ * @return @transfer{none} @c NULL if the document is no longer open.
*
* Example:
* @code
@@ -366,7 +366,7 @@ GeanyDocument *document_get_from_notebook_child(GtkWidget *page)
*
* @param page_num The notebook page number to search.
*
- * @return The corresponding document for the given notebook page, or @c NULL.
+ * @return @transfer{none} The corresponding document for the given notebook page, or @c NULL.
**/
GEANY_API_SYMBOL
GeanyDocument *document_get_from_page(guint page_num)
@@ -385,7 +385,7 @@ GeanyDocument *document_get_from_page(guint page_num)
/**
* Finds the current document.
*
- * @return A pointer to the current document or @c NULL if there are no opened documents.
+ * @return @transfer{none} A pointer to the current document or @c NULL if there are no opened documents.
**/
GEANY_API_SYMBOL
GeanyDocument *document_get_current(void)
@@ -830,7 +830,7 @@ GeanyDocument *document_new_file_if_non_open(void)
* @param ft The filetype to set or @c NULL to detect it from @a filename if not @c NULL.
* @param text The initial content of the file (in UTF-8 encoding), or @c NULL.
*
- * @return The new document.
+ * @return @transfer{none} The new document.
**/
GEANY_API_SYMBOL
GeanyDocument *document_new_file(const gchar *utf8_filename, GeanyFiletype *ft, const gchar *text)
@@ -914,7 +914,7 @@ GeanyDocument *document_new_file(const gchar *utf8_filename, GeanyFiletype *ft,
* @param ft The filetype for the document or @c NULL to auto-detect the filetype.
* @param forced_enc The file encoding to use or @c NULL to auto-detect the file encoding.
*
- * @return The document opened or @c NULL.
+ * @return @transfer{none} The document opened or @c NULL.
**/
GEANY_API_SYMBOL
GeanyDocument *document_open_file(const gchar *locale_filename, gboolean readonly,
@@ -1558,7 +1558,7 @@ void document_open_file_list(const gchar *data, gsize length)
* Opens each file in the list @a filenames.
* Internally, document_open_file() is called for every list item.
*
- * @param filenames A list of filenames to load, in locale encoding.
+ * @param filenames @elementtype{filename} A list of filenames to load, in locale encoding.
* @param readonly Whether to open the document in read-only mode.
* @param ft The filetype for the document or @c NULL to auto-detect the filetype.
* @param forced_enc The file encoding to use or @c NULL to auto-detect the file encoding.
@@ -3290,7 +3290,7 @@ const GdkColor *document_get_status_color(GeanyDocument *doc)
/** Accessor function for @ref documents_array items.
* @warning Always check the returned document is valid (@c doc->is_valid).
* @param idx @c documents_array index.
- * @return The document, or @c NULL if @a idx is out of range.
+ * @return @transfer{none} The document, or @c NULL if @a idx is out of range.
*
* @since 0.16
*/
Modified: src/editor.c
2 lines changed, 1 insertions(+), 1 deletions(-)
===================================================================
@@ -4871,7 +4871,7 @@ static ScintillaObject *create_new_sci(GeanyEditor *editor)
/** Creates a new Scintilla @c GtkWidget based on the settings for @a editor.
* @param editor Editor settings.
- * @return The new widget.
+ * @return @transfer{floating} The new widget.
*
* @since 0.15
**/
Modified: src/editor.h
2 lines changed, 2 insertions(+), 0 deletions(-)
===================================================================
@@ -50,6 +50,8 @@ typedef enum
}
GeanyIndentType;
+/** @addtogir
+ * Auto indentation modes */
typedef enum
{
GEANY_AUTOINDENT_NONE = 0,
Modified: src/filetypes.c
19 lines changed, 13 insertions(+), 6 deletions(-)
===================================================================
@@ -55,7 +55,14 @@
#define GEANY_FILETYPE_SEARCH_LINES 2 /* lines of file to search for filetype */
-GPtrArray *filetypes_array = NULL; /* Dynamic array of filetype pointers */
+/** Dynamic array of filetype pointers
+ *
+ * List the list is dynamically expanded for custom filetypes filetypes so don't expect
+ * the list of known filetypes to be a constant.
+ *
+ * @elementtype{GeanyFiletype}
+ * */
+GPtrArray *filetypes_array = NULL;
static GHashTable *filetypes_hash = NULL; /* Hash of filetype pointers based on name keys */
@@ -233,7 +240,7 @@ static gint cmp_filetype(gconstpointer pft1, gconstpointer pft2, gpointer data)
/** Gets a list of filetype pointers sorted by name.
* The list does not change on subsequent calls.
- * @return The list - do not free.
+ * @return @elementtype{GeanyFiletype} @transfer{none} The list - do not free.
* @see filetypes_by_title. */
GEANY_API_SYMBOL
const GSList *filetypes_get_sorted_by_name(void)
@@ -764,8 +771,8 @@ GeanyFiletype *filetypes_detect_from_document(GeanyDocument *doc)
*
* @param utf8_filename The filename in UTF-8 encoding.
*
- * @return The detected filetype for @a utf8_filename or @c filetypes[GEANY_FILETYPES_NONE]
- * if it could not be detected.
+ * @return @transfer{none} The detected filetype for @a utf8_filename or
+ * @c filetypes[GEANY_FILETYPES_NONE] if it could not be detected.
**/
GEANY_API_SYMBOL
GeanyFiletype *filetypes_detect_from_file(const gchar *utf8_filename)
@@ -1246,7 +1253,7 @@ gboolean filetype_has_tags(GeanyFiletype *ft)
/** Finds a filetype pointer from its @a name field.
* @param name Filetype name.
- * @return The filetype found, or @c NULL.
+ * @return @transfer{none} The filetype found, or @c NULL.
*
* @since 0.15
**/
@@ -1492,7 +1499,7 @@ void filetypes_reload_extensions(void)
/** Accessor function for @ref GeanyData::filetypes_array items.
* Example: @code ft = filetypes_index(GEANY_FILETYPES_C); @endcode
* @param idx @c filetypes_array index.
- * @return The filetype, or @c NULL if @a idx is out of range.
+ * @return @transfer{none} The filetype, or @c NULL if @a idx is out of range.
*
* @since 0.16
*/
Modified: src/filetypes.h
3 lines changed, 3 insertions(+), 0 deletions(-)
===================================================================
@@ -113,6 +113,9 @@ GeanyFiletypeID;
#define filetype_id GeanyFiletypeID /* compat define - should be removed in the future */
+/** Filetype categories
+ *
+ * These are used to provide submenus for each category in the GUI */
typedef enum
{
GEANY_FILETYPE_GROUP_NONE,
Modified: src/keybindings.c
10 lines changed, 5 insertions(+), 5 deletions(-)
===================================================================
@@ -133,7 +133,7 @@ GdkModifierType keybindings_get_modifiers(GdkModifierType mods)
/** Looks up a keybinding item.
* @param group Group.
* @param key_id Keybinding index for the group.
- * @return The keybinding.
+ * @return @transfer{none} The keybinding.
* @since 0.19. */
GEANY_API_SYMBOL
GeanyKeyBinding *keybindings_get_item(GeanyKeyGroup *group, gsize key_id)
@@ -216,11 +216,11 @@ GeanyKeyBinding *keybindings_set_item(GeanyKeyGroup *group, gsize key_id,
* @param kf_name Key name for the configuration file, such as @c "menu_new".
* @param label Label used in the preferences dialog keybindings tab. May contain
* underscores - these won't be displayed.
- * @param menu_item Optional widget to set an accelerator for, or @c NULL.
- * @param cb New-style callback to be called when activated, or @c NULL to use the group callback.
- * @param pdata Plugin-specific data passed back to the callback.
+ * @param menu_item @null Optional widget to set an accelerator for, or @c NULL.
+ * @param cb @null New-style callback to be called when activated, or @c NULL to use the group callback.
+ * @param pdata Plugin-specific data passed back to the callback @a cb.
* @param destroy_notify Function that is invoked to free the plugin data when not needed anymore.
- * @return The keybinding - normally this is ignored.
+ * @return @transfer{none} The keybinding - normally this is ignored.
*
* @since 1.26 (API 226)
* @see See plugin_set_key_group_full
Modified: src/plugindata.h
4 lines changed, 2 insertions(+), 2 deletions(-)
===================================================================
@@ -222,8 +222,8 @@ typedef struct GeanyData
{
struct GeanyApp *app; /**< Geany application data fields */
struct GeanyMainWidgets *main_widgets; /**< Important widgets in the main window */
- GPtrArray *documents_array; /**< See document.h#documents_array. */
- GPtrArray *filetypes_array; /**< Dynamic array of GeanyFiletype pointers */
+ GPtrArray *documents_array; /**< See document.h#documents_array. @elementtype{GeanyDocument} */
+ GPtrArray *filetypes_array; /**< Dynamic array of GeanyFiletype pointers. @elementtype{GeanyFiletype} */
struct GeanyPrefs *prefs; /**< General settings */
struct GeanyInterfacePrefs *interface_prefs; /**< Interface settings */
struct GeanyToolbarPrefs *toolbar_prefs; /**< Toolbar settings */
Modified: src/pluginutils.c
16 lines changed, 11 insertions(+), 5 deletions(-)
===================================================================
@@ -128,7 +128,9 @@ void plugin_module_make_resident(GeanyPlugin *plugin)
* object has been destroyed), and disconnect yourself or not as appropriate.
* @note Since version 1.25 (API >= 218), the object lifetime is watched and so the above
* restriction does not apply. However, for objects destroyed by the plugin,
- * @c g_signal_connect() is safe and has lower overhead. */
+ * @c g_signal_connect() is safe and has lower overhead.
+ * @skip
+ **/
GEANY_API_SYMBOL
void plugin_signal_connect(GeanyPlugin *plugin,
GObject *object, const gchar *signal_name, gboolean after,
@@ -241,6 +243,7 @@ static guint plugin_source_add(GeanyPlugin *plugin, GSource *source, GSourceFunc
*
* @see g_timeout_add()
* @since 0.21, plugin API 205.
+ * @skip
*/
GEANY_API_SYMBOL
guint plugin_timeout_add(GeanyPlugin *plugin, guint interval, GSourceFunc function, gpointer data)
@@ -261,6 +264,7 @@ guint plugin_timeout_add(GeanyPlugin *plugin, guint interval, GSourceFunc functi
*
* @see g_timeout_add_seconds()
* @since 0.21, plugin API 205.
+ * @skip
*/
GEANY_API_SYMBOL
guint plugin_timeout_add_seconds(GeanyPlugin *plugin, guint interval, GSourceFunc function,
@@ -281,6 +285,7 @@ guint plugin_timeout_add_seconds(GeanyPlugin *plugin, guint interval, GSourceFun
*
* @see g_idle_add()
* @since 0.21, plugin API 205.
+ * @skip
*/
GEANY_API_SYMBOL
guint plugin_idle_add(GeanyPlugin *plugin, GSourceFunc function, gpointer data)
@@ -296,7 +301,8 @@ guint plugin_idle_add(GeanyPlugin *plugin, GSourceFunc function, gpointer data)
* @param count Number of keybindings for the group.
* @param callback Group callback, or @c NULL if you only want individual keybinding callbacks.
* @return The plugin's keybinding group.
- * @since 0.19. */
+ * @since 0.19.
+ * @skip */
GEANY_API_SYMBOL
GeanyKeyGroup *plugin_set_key_group(GeanyPlugin *plugin,
const gchar *section_name, gsize count, GeanyKeyGroupCallback callback)
@@ -315,10 +321,10 @@ GeanyKeyGroup *plugin_set_key_group(GeanyPlugin *plugin,
* @param plugin Must be @ref geany_plugin.
* @param section_name Name used in the configuration file, such as @c "html_chars".
* @param count Number of keybindings for the group.
- * @param cb New-style group callback, or @c NULL if you only want individual keybinding callbacks.
- * @param pdata Plugin specific data, passed to the group callback.
+ * @param cb @null New-style group callback, or @c NULL if you only want individual keybinding callbacks.
+ * @param pdata Plugin specific data, passed to the group callback @a cb.
* @param destroy_notify Function that is invoked to free the plugin data when not needed anymore.
- * @return The plugin's keybinding group.
+ * @return @transfer{none} The plugin's keybinding group.
*
* @since 1.26 (API 226)
* @see See keybindings_set_item
Modified: src/search.h
9 lines changed, 6 insertions(+), 3 deletions(-)
===================================================================
@@ -43,12 +43,15 @@ typedef enum GeanyFindFlags
}
GeanyFindFlags;
-enum GeanyFindSelOptions
+/** @addtogir
+ * Find selection options */
+typedef enum
{
GEANY_FIND_SEL_CURRENT_WORD,
GEANY_FIND_SEL_X,
GEANY_FIND_SEL_AGAIN
-};
+}
+GeanyFindSelOptions;
/** Search preferences */
typedef struct GeanySearchPrefs
@@ -58,7 +61,7 @@ typedef struct GeanySearchPrefs
gboolean use_current_file_dir; /* find in files directory to use on showing dialog */
gboolean hide_find_dialog; /* hide the find dialog on next or previous */
gboolean replace_and_find_by_default; /* enter in replace window performs Replace & Find instead of Replace */
- enum GeanyFindSelOptions find_selection_type;
+ GeanyFindSelOptions find_selection_type;
}
GeanySearchPrefs;
Modified: src/spawn.c
1 lines changed, 1 insertions(+), 0 deletions(-)
===================================================================
@@ -999,6 +999,7 @@ static void spawn_watch_cb(GPid pid, gint status, gpointer data)
* @return @c TRUE on success, @c FALSE on error.
*
* @since 1.25
+ * @skip
**/
GEANY_API_SYMBOL
gboolean spawn_with_callbacks(const gchar *working_directory, const gchar *command_line,
Modified: src/stash.c
2 lines changed, 1 insertions(+), 1 deletions(-)
===================================================================
@@ -359,7 +359,7 @@ static void free_stash_pref(StashPref *pref)
/** Creates a new group.
* @param name Name used for @c GKeyFile group.
- * @return Group. */
+ * @return @transfer{full} Group. */
GEANY_API_SYMBOL
StashGroup *stash_group_new(const gchar *name)
{
Modified: src/ui_utils.c
29 lines changed, 19 insertions(+), 10 deletions(-)
===================================================================
@@ -1461,7 +1461,10 @@ void ui_update_view_editor_menu_items(void)
/** Creates a GNOME HIG-style frame (with no border and indented child alignment).
* @param label_text The label text.
* @param alignment An address to store the alignment widget pointer.
- * @return The frame widget, setting the alignment container for packing child widgets. */
+ *
+ * @return @transfer{floating} The frame widget, setting the alignment container for
+ * packing child widgets.
+ **/
GEANY_API_SYMBOL
GtkWidget *ui_frame_new_with_alignment(const gchar *label_text, GtkWidget **alignment)
{
@@ -1484,7 +1487,8 @@ GtkWidget *ui_frame_new_with_alignment(const gchar *label_text, GtkWidget **alig
/** Makes a fixed border for dialogs without increasing the button box border.
* @param dialog The parent container for the @c GtkVBox.
- * @return The packed @c GtkVBox. */
+ *
+ * @return @transfer{none} The packed @c GtkVBox. */
GEANY_API_SYMBOL
GtkWidget *ui_dialog_vbox_new(GtkDialog *dialog)
{
@@ -1535,7 +1539,8 @@ void ui_dialog_set_primary_button_order(GtkDialog *dialog, gint response, ...)
* @c gtk_button_new_from_stock().
* @param stock_id A @c GTK_STOCK_NAME string.
* @param text Button label text, can include mnemonics.
- * @return The new @c GtkButton.
+ *
+ * @return @transfer{floating} The new @c GtkButton.
*/
GEANY_API_SYMBOL
GtkWidget *ui_button_new_with_image(const gchar *stock_id, const gchar *text)
@@ -1554,7 +1559,7 @@ GtkWidget *ui_button_new_with_image(const gchar *stock_id, const gchar *text)
/** Creates a @c GtkImageMenuItem with a stock image and a custom label.
* @param stock_id Stock image ID, e.g. @c GTK_STOCK_OPEN.
* @param label Menu item label, can include mnemonics.
- * @return The new @c GtkImageMenuItem.
+ * @return @transfer{floating} The new @c GtkImageMenuItem.
*
* @since 0.16
*/
@@ -1898,7 +1903,8 @@ void ui_widget_modify_font_from_string(GtkWidget *widget, const gchar *str)
* @param action The mode of the file chooser.
* @param entry Can be an unpacked @c GtkEntry, or the child of an unpacked widget,
* such as @c GtkComboBoxEntry.
- * @return The @c GtkHBox.
+ *
+ * @return @transfer{floating} The @c GtkHBox.
*/
/* @see ui_setup_open_button_callback(). */
GEANY_API_SYMBOL
@@ -2651,7 +2657,8 @@ void ui_widget_set_tooltip_text(GtkWidget *widget, const gchar *text)
* you want returned.
* @param widget Widget with the @a widget_name property set.
* @param widget_name Name to lookup.
- * @return The widget found.
+ *
+ * @return @transfer{none} The widget found.
* @see ui_hookup_widget().
*
* @since 0.16
@@ -2839,10 +2846,11 @@ GtkWidget *ui_label_new_bold(const gchar *text)
/** Adds a list of document items to @a menu.
* @param menu Menu.
* @param active Which document to highlight, or @c NULL.
- * @param callback is used for each menu item's @c "activate" signal and will be passed
- * the corresponding document pointer as @c user_data.
+ * @param callback is used for each menu item's @c "activate" signal and will be
+ * passed the corresponding document pointer as @c user_data.
* @warning You should check @c doc->is_valid in the callback.
- * @since 0.19 */
+ * @since 0.19
+ * @skip */
GEANY_API_SYMBOL
void ui_menu_add_document_items(GtkMenu *menu, GeanyDocument *active, GCallback callback)
{
@@ -2863,7 +2871,8 @@ void ui_menu_add_document_items(GtkMenu *menu, GeanyDocument *active, GCallback
* the corresponding document pointer as @c user_data.
* @param compare_func is used to sort the list. Might be @c NULL to not sort the list.
* @warning You should check @c doc->is_valid in the callback.
- * @since 0.21 */
+ * @since 0.21
+ * @skip */
GEANY_API_SYMBOL
void ui_menu_add_document_items_sorted(GtkMenu *menu, GeanyDocument *active,
GCallback callback, GCompareFunc compare_func)
Modified: src/utils.c
15 lines changed, 8 insertions(+), 7 deletions(-)
===================================================================
@@ -1405,8 +1405,8 @@ gint utils_mkdir(const gchar *path, gboolean create_parent_dirs)
* @param sort Whether to sort alphabetically (UTF-8 safe).
* @param error The location for storing a possible error, or @c NULL.
*
- * @return A newly allocated list or @c NULL if no files were found. The list and its data should be
- * freed when no longer needed.
+ * @return @elementtype{filename} @transfer{full} A newly allocated list or @c NULL if
+ * no files were found. The list and its data should be freed when no longer needed.
* @see utils_get_file_list().
**/
GEANY_API_SYMBOL
@@ -1450,8 +1450,8 @@ GSList *utils_get_file_list_full(const gchar *path, gboolean full_path, gboolean
* unless @c NULL.
* @param error The location for storing a possible error, or @c NULL.
*
- * @return A newly allocated list or @c NULL if no files were found. The list and its data should be
- * freed when no longer needed.
+ * @return @elementtype{filename} @transfer{full} A newly allocated list or @c NULL
+ * if no files were found. The list and its data should be freed when no longer needed.
* @see utils_get_file_list_full().
**/
GEANY_API_SYMBOL
@@ -1651,7 +1651,7 @@ const gchar *utils_get_default_dir_utf8(void)
* @param argv The child's argument vector.
* @param env The child's environment, or @c NULL to inherit parent's.
* @param flags Ignored.
- * @param child_setup Ignored.
+ * @param child_setup @skip Ignored.
* @param user_data Ignored.
* @param std_out The return location for child output, or @c NULL.
* @param std_err The return location for child error messages, or @c NULL.
@@ -1686,7 +1686,7 @@ gboolean utils_spawn_sync(const gchar *dir, gchar **argv, gchar **env, GSpawnFla
* @param argv The child's argument vector.
* @param env The child's environment, or @c NULL to inherit parent's.
* @param flags Ignored.
- * @param child_setup Ignored.
+ * @param child_setup @skip Ignored.
* @param user_data Ignored.
* @param child_pid The return location for child process ID, or NULL.
* @param error The return location for error or @c NULL.
@@ -1955,11 +1955,12 @@ static gboolean str_in_array(const gchar **haystack, const gchar *needle)
*
* The argument list must be @c NULL-terminated.
*
+ *
* @param exclude_vars @c NULL-terminated array of variable names to exclude.
* @param first_varname Name of the first variable to copy into the new array.
* @param ... Key-value pairs of variable names and values, @c NULL-terminated.
*
- * @return The new environment array. Use @c g_strfreev() to free it.
+ * @return @transfer{full} The new environment array. Use @c g_strfreev() to free it.
**/
GEANY_API_SYMBOL
gchar **utils_copy_environment(const gchar **exclude_vars, const gchar *first_varname, ...)
Modified: tagmanager/src/tm_workspace.c
4 lines changed, 2 insertions(+), 2 deletions(-)
===================================================================
@@ -267,7 +267,7 @@ static void tm_workspace_update(void)
/** Adds multiple source files to the workspace and updates the workspace tag arrays.
This is more efficient than calling tm_workspace_add_source_file() and
tm_workspace_update_source_file() separately for each of the files.
- @param source_files The source files to be added to the workspace.
+ @param source_files @elementtype{TMSourceFile} The source files to be added to the workspace.
*/
GEANY_API_SYMBOL
void tm_workspace_add_source_files(GPtrArray *source_files)
@@ -292,7 +292,7 @@ void tm_workspace_add_source_files(GPtrArray *source_files)
arrays. This is more efficient than calling tm_workspace_remove_source_file()
separately for each of the files. To completely free the TMSourceFile pointers
call tm_source_file_free() on each of them.
- @param source_files The source files to be removed from the workspace.
+ @param source_files @elementtype{TMSourceFile} The source files to be removed from the workspace.
*/
GEANY_API_SYMBOL
void tm_workspace_remove_source_files(GPtrArray *source_files)
--------------
This E-Mail was brought to you by github_commit_mail.py (Source: https://github.com/geany/infrastructure).
More information about the Commits
mailing list