From 5cf3e2e1d768e2815831d61faa7560d589929b0d Mon Sep 17 00:00:00 2001
From: Boris Kolpackov <boris@codesynthesis.com>
Date: Wed, 24 Jun 2015 17:32:35 +0200
Subject: Document path::extension() better

---
 butl/path | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

(limited to 'butl/path')

diff --git a/butl/path b/butl/path
index 451600c..af01d05 100644
--- a/butl/path
+++ b/butl/path
@@ -343,7 +343,9 @@ namespace butl
     basic_path
     base () const;
 
-    // Return the extension or NULL if not present.
+    // Return the extension or NULL if not present. If not NULL, then
+    // the result points to the character past the dot but it is legal
+    // to decrement it once to obtain the value with the dot.
     //
     const C*
     extension () const;
-- 
cgit v1.1