gnucash maint: Update description of gnc_gnome_help and gnc_launch_assoc
Frank H.Ellenberger
fell at code.gnucash.org
Sat May 30 19:41:01 EDT 2020
Updated via https://github.com/Gnucash/gnucash/commit/76015bd0 (commit)
from https://github.com/Gnucash/gnucash/commit/2522f08d (commit)
commit 76015bd0b6f74290a8a10874b0409d24b449d6e5
Author: Frank H. Ellenberger <frank.h.ellenberger at gmail.com>
Date: Sat May 30 18:17:14 2020 +0200
Update description of gnc_gnome_help and gnc_launch_assoc
diff --git a/gnucash/gnome-utils/gnc-gnome-utils.h b/gnucash/gnome-utils/gnc-gnome-utils.h
index e4a1dd636..e1cd9422d 100644
--- a/gnucash/gnome-utils/gnc-gnome-utils.h
+++ b/gnucash/gnome-utils/gnc-gnome-utils.h
@@ -43,20 +43,18 @@
*/
void gnc_add_css_file (void);
-/** Launch the default gnome help browser and open to a given link
- * within a given file. This routine will display an error message
+/** Launch the systems default help browser, gnome's yelp for linux,
+ * and open to a given link within a given file.
+ * This routine will display an error message
* if it can't find the help file or can't open the help browser.
*
* @param file_name The name of the help file.
*
- * @param anchor The anchor the help browser should scroll to..
- *
- * @return the full path name of the file, or NULL of the file can't
- * be found.
+ * @param anchor The anchor the help browser should scroll to.
*/
void gnc_gnome_help (const char *file_name,
const char *anchor);
-/** Launch the default gnome browser and open the provided URI.
+/** Launch the default browser and open the provided URI.
*/
void gnc_launch_assoc (GtkWindow *parent, const char *uri);
Summary of changes:
gnucash/gnome-utils/gnc-gnome-utils.h | 12 +++++-------
1 file changed, 5 insertions(+), 7 deletions(-)
More information about the gnucash-changes
mailing list