[monkey-bubble: 125/753] Added documentation to gnome_program_locate_file():



commit 616b964ca831097a67f3ecbff8f85cd4c7c98ad6
Author: Martin Baulig <martin src gnome org>
Date:   Wed Apr 11 18:21:48 2001 +0000

    Added documentation to gnome_program_locate_file():
    
     *   NOTE: This function is to locate system-wide files, such as files which
     *         have been installed by libgnomeui-2 or another platform library.
     *
     *         Do *NOT* use it to locate files which are installed by your own
     *         application; if you have an application `foo' and you want to
     *         load a pixmap `foo.png' which it installs, define FOOPIXMAPDIR
     *         in your app's Makefile.am and use FOOPIXMAPDIR "/foo.png".
     *

 libgnome/gnome-program.c |    8 ++++++++
 1 files changed, 8 insertions(+), 0 deletions(-)
---
diff --git a/libgnome/gnome-program.c b/libgnome/gnome-program.c
index 559363e..3d748ea 100644
--- a/libgnome/gnome-program.c
+++ b/libgnome/gnome-program.c
@@ -759,6 +759,14 @@ gnome_program_install_property (GnomeProgramClass *pclass,
  * "domain". A domain is a name for a collection of related files.
  * For example, common domains are "libdir", "pixmap", and "config".
  *
+ *   NOTE: This function is to locate system-wide files, such as files which
+ *         have been installed by libgnomeui-2 or another platform library.
+ *
+ *         Do *NOT* use it to locate files which are installed by your own
+ *         application; if you have an application `foo' and you want to
+ *         load a pixmap `foo.png' which it installs, define FOOPIXMAPDIR
+ *         in your app's Makefile.am and use FOOPIXMAPDIR "/foo.png".
+ *
  * The ret_locations list and its contents should be freed by the caller.
  *
  * Returns: The full path to the file (if it exists or only_if_exists is



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]