changeset 12891:54ea3d6e657c

added src level documentation for the get_path() function
author al
date Fri, 23 Jul 2004 16:35:20 +0000
parents 9a45f43bf9a0
children 4e3f8c72d3eb
files get_path.c
diffstat 1 files changed, 9 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/get_path.c	Fri Jul 23 16:10:21 2004 +0000
+++ b/get_path.c	Fri Jul 23 16:35:20 2004 +0000
@@ -1,4 +1,13 @@
 
+/*
+ * Get path to config dir/file.
+ *
+ * Return Values:
+ *   Returns the pointer to the ALLOCATED buffer containing the
+ *   zero terminated path string. This buffer has to be FREED
+ *   by the caller.
+ *
+ */
 char *get_path(char *filename){
 	char *homedir;
 	char *buff;