Update description of gnc_gnome_help and gnc_launch_assoc

This commit is contained in:
Frank H. Ellenberger 2020-05-30 18:17:14 +02:00
parent 2522f08d0c
commit 76015bd0b6

View File

@ -43,20 +43,18 @@
*/ */
void gnc_add_css_file (void); void gnc_add_css_file (void);
/** Launch the default gnome help browser and open to a given link /** Launch the systems default help browser, gnome's yelp for linux,
* within a given file. This routine will display an error message * 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. * 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 file_name The name of the help file.
* *
* @param anchor The anchor the help browser should scroll to.. * @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.
*/ */
void gnc_gnome_help (const char *file_name, void gnc_gnome_help (const char *file_name,
const char *anchor); 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); void gnc_launch_assoc (GtkWindow *parent, const char *uri);