[geany/geany] 79db59: Add API docs for search_show_find_in_files_dialog()

Matthew Brush git-noreply at xxxxx
Sat Jun 15 19:45:45 UTC 2013


Branch:      refs/heads/master
Author:      Matthew Brush <matt at geany.org>
Committer:   Matthew Brush <matt at geany.org>
Date:        Sat, 15 Jun 2013 19:45:45 UTC
Commit:      79db59d0190be414a9d379bdd7c01b127d3a85d4
             https://github.com/geany/geany/commit/79db59d0190be414a9d379bdd7c01b127d3a85d4

Log Message:
-----------
Add API docs for search_show_find_in_files_dialog()

This function is used in File Browser plugin and in Tree Browser,
GProject, and GeanyPrj plugins from Geany-Plugins.


Modified Paths:
--------------
    src/search.c

Modified: src/search.c
10 files changed, 8 insertions(+), 2 deletions(-)
===================================================================
@@ -1017,8 +1017,14 @@ static void create_fif_dialog(void)
 }
 
 
-/* dir is the directory to search in (UTF-8 encoding), may be NULL to determine it the usual way
- * by using the current file's path */
+/**
+ * Shows the Find in Files dialog.
+ *
+ * @param dir The directory to search in (UTF-8 encoding). May be @c NULL
+ * to determine it the usual way by using the current document's path.
+ *
+ * @since 0.14, plugin API 53
+ */
 void search_show_find_in_files_dialog(const gchar *dir)
 {
 	search_show_find_in_files_dialog_full(NULL, dir);



--------------
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