From e3d4594eb7a2f9db7fc31ec0cc5ae119be3fa55a Mon Sep 17 00:00:00 2001
From: Tom Willemsen
Date: Fri, 28 Dec 2012 22:03:55 +0100
Subject: Add/improve some documentation comments

Since CHICKEN scheme doesn't do docstrings I'm just using comments.
---
 src/paths.scm | 8 ++++++++
 1 file changed, 8 insertions(+)

(limited to 'src/paths.scm')

diff --git a/src/paths.scm b/src/paths.scm
index af2fe2e..5f4f2d2 100644
--- a/src/paths.scm
+++ b/src/paths.scm
@@ -23,6 +23,9 @@
 (declare (unit paths))
 
 (define (stored-file xdg-env file)
+  ;; Get FILE either from `XDG-ENV/linkwave/' or from
+  ;; `$HOME/.linkwave/'.  Prefer any existing file over any other, but
+  ;; prefer files using XDG-ENV over `$HOME'.
   (let ((xdg (get-environment-variable xdg-env))
         (stored-file (string-append (get-environment-variable "HOME") "/.linkwave/" file)))
     (unless (or (file-exists? stored-file) (not xdg))
@@ -31,8 +34,13 @@
 
 (: config-file (string -> string))
 (define (config-file file)
+  ;; Use `stored-file' to get configuration file FILE.  Configuration
+  ;; files are stored under `$XDG_CONFIG_HOME' if the XDG standard is
+  ;; used.
   (stored-file "XDG_CONFIG_HOME" file))
 
 (: data-file (string -> string))
 (define (data-file file)
+  ;; Use `stored-file' to get data file FILE. Data files are stored
+  ;; under `$XDG_DATA_HOME' if the XDG standard is used.
   (stored-file "XDG_DATA_HOME" file))
-- 
cgit v1.3-2-g0d8e