add a bit documentation
authorpenk
Mon, 01 Dec 2003 12:13:12 +0100
changeset 1368 cada7bfb7769
parent 1367 85aebc08d304
child 1369 65ba75319c22
add a bit documentation
FileSorter.st
--- a/FileSorter.st	Mon Dec 01 12:06:50 2003 +0100
+++ b/FileSorter.st	Mon Dec 01 12:13:12 2003 +0100
@@ -7,6 +7,30 @@
 	category:'Interface-Tools-File'
 !
 
+!FileSorter class methodsFor:'documentation'!
+
+documentation
+"
+    sort files by selector
+    care for directoriesBeforeFiles sortCaseless sortReverse
+
+    [author:]
+        Christian Penk
+
+    [instance variables:]
+    directoriesBeforeFiles: if true all directories and files will be sorted 
+                            independently by the selector and the directories 
+                            are before files 
+    sortCaseless:           if true and the selector is #baseName ignore upper
+                            and lowercase in sort
+    sortReverse:            if true starts with highest value of the sort
+
+    [class variables:]
+
+    [see also:]
+
+"
+! !
 
 !FileSorter class methodsFor:'instance creation'!
 
@@ -17,7 +41,7 @@
 !FileSorter methodsFor:'accessing'!
 
 directoriesBeforeFiles
-    ^ directoriesBeforeFiles
+    ^ directoriesBeforeFiles ? false
 !
 
 directoriesBeforeFiles:something
@@ -42,7 +66,7 @@
 !
 
 sortCaseless
-    ^ sortCaseless
+    ^ sortCaseless ? false
 !
 
 sortCaseless:something
@@ -116,5 +140,5 @@
 !FileSorter class methodsFor:'documentation'!
 
 version
-    ^ '$Header: /cvs/stx/stx/libbasic2/FileSorter.st,v 1.1 2003-12-01 11:06:50 penk Exp $'
+    ^ '$Header: /cvs/stx/stx/libbasic2/FileSorter.st,v 1.2 2003-12-01 11:13:12 penk Exp $'
 ! !