class: Tools::BrowserList
authorClaus Gittinger <cg@exept.de>
Mon, 02 Mar 2015 10:54:15 +0100
changeset 15491 84078ac52fa0
parent 15490 6c36db8ba766
child 15492 8a58c96052b4
class: Tools::BrowserList comment/format in: #documentation
Tools__BrowserList.st
--- a/Tools__BrowserList.st	Sun Mar 01 22:53:36 2015 +0100
+++ b/Tools__BrowserList.st	Mon Mar 02 10:54:15 2015 +0100
@@ -1,3 +1,5 @@
+"{ Encoding: utf8 }"
+
 "
  COPYRIGHT (c) 2004 by eXept Software AG
               All Rights Reserved
@@ -54,9 +56,19 @@
 
 documentation
 "
-    embeddable application displaying the class-categories.
-    Provides an outputGenerator, which enumerates the classes in
-    the selected categories.
+    embeddable application displaying a browser's list.
+    I am a pluggable component, which gets an input collection
+    (typically a generator/iterator), which tells me what to display
+    in the list.
+    When an item is selected, I provides a similar outputGenerator, 
+    which enumerates the selected sub-items.
+    Concrete subclasses exist, to present lists of:
+        class-categories (and generate a list of classes),
+        packages (and generate a list of classes),
+        namespaces (generates a list of classes),
+        classes (and generate a list of methods+method category,
+        method-categories (and generate a list of methods),
+        methods
 
     [author:]
         Claus Gittinger (cg@exept.de)
@@ -2100,10 +2112,10 @@
 !BrowserList class methodsFor:'documentation'!
 
 version
-    ^ '$Header: /cvs/stx/stx/libtool/Tools__BrowserList.st,v 1.83 2015-02-16 14:46:25 cg Exp $'
+    ^ '$Header: /cvs/stx/stx/libtool/Tools__BrowserList.st,v 1.84 2015-03-02 09:54:15 cg Exp $'
 !
 
 version_CVS
-    ^ '$Header: /cvs/stx/stx/libtool/Tools__BrowserList.st,v 1.83 2015-02-16 14:46:25 cg Exp $'
+    ^ '$Header: /cvs/stx/stx/libtool/Tools__BrowserList.st,v 1.84 2015-03-02 09:54:15 cg Exp $'
 ! !