Make Path behave more consistently by always starting relative paths with a dot

[libs/core.git] / source / path.h

diff --git a/source/path.h b/source/path.h
index 8c24f191394e5198d14fd7222f54f3c7bf1a6df6..751c0e3d2f66a3580e590402322d4a6aa1fb6af6 100644 (file)
--- a/source/path.h
+++ b/source/path.h
@@ -23,6 +23,11 @@ enum
 #endif
 };
 
+/**
+Stores a filesystem path.  Paths are always stored in a normalized form; there
+are never any "." or ".." components in the middle of the path, and relative
+paths always begin with a single "." component or a sequence ".." components.
+*/
 class Path
 {
 public: