please doxygen

git-svn-id: file:///svn/unbound/trunk@1040 be551aaa-1e26-0410-a405-d3ace91eadb9

diff --git a/smallapp/unbound-checkconf.c b/smallapp/unbound-checkconf.c
index 1fb997d832bd996717ddd83ffcfba14085844281..e06855d0d0150983e9617a1eb47c3dc7b61815a7 100644 (file)
--- a/smallapp/unbound-checkconf.c
+++ b/smallapp/unbound-checkconf.c
@@ -214,7 +214,13 @@ is_dir(const char* fname)
        return 1;
 }
 
-/** convert a filename to full pathname in original filesys. return static */
+/** convert a filename to full pathname in original filesys
+ * @param fname: the path name to convert.
+ *     Must not be null or empty.
+ * @param cfg: config struct for chroot and chdir (if set).
+ * @param use_chdir: if false, only chroot is applied.
+ * @return pointer to static buffer which is: [chroot][chdir]fname
+ */
 static char*
 fname_after_chroot(const char* fname, struct config_file* cfg, int use_chdir)
 {