comment/format in: #documentation expecco_2_4_0 expecco_2_4_1
authorClaus Gittinger <cg@exept.de>
Wed, 24 Oct 2012 15:08:09 +0200
changeset 2936 914fbb4edbae
parent 2935 65ca67754d14
child 2937 7c1b0cbd5862
comment/format in: #documentation
MenuEditor.st
--- a/MenuEditor.st	Tue Oct 23 15:59:12 2012 +0200
+++ b/MenuEditor.st	Wed Oct 24 15:08:09 2012 +0200
@@ -103,37 +103,41 @@
 documentation
 "
     The MenuEditor allows you to create, modify or just inspect
-    menus.
-
+    menu specifications. Such specifications are returned by menu-spec methods
+    of the application class. These methods are typically tagged with a menu-resource.
+    The menu editor is able to retrieve such specifications and generate new menu-spec
+    methods.
+
+    The editor is typically opened by double-clicking on a menu-spec method in the browser.
 
     [Instance variables:]
 
-	listOfItemsView         <HierarcicalListView>  the view which shows the list of items
-	listOfItems             <HierarchicalList>     hierarchical list of menu items
-	listOfTabs              <List>                 list of current shown tab-labels
-
-	selectionHolder         <ValueHolder>          collection of current selected items
-	selectedSuperItems      <Collection>           collection of superItems derived from selection
-
-	tabHolder               <ValueHolder>          selected tab label holder
-	notifyDisabledCounter   <SmallInteger>         ~~ 0 than change notifications are discard
-	wizards                 <IdentityDictionary>   keeps all created wizard dialogs
-
-	dropOverLine            <nil or SmallInteger>  nil: drop context not dropabel.
-						       = 0: drop context dropable but no item specified
-						       ~ 0: drop context dropable for item at lineNumber
-						       used t6o restore drop indication drawings
+        listOfItemsView         <HierarcicalListView>  the view which shows the list of items
+        listOfItems             <HierarchicalList>     hierarchical list of menu items
+        listOfTabs              <List>                 list of current shown tab-labels
+
+        selectionHolder         <ValueHolder>          collection of current selected items
+        selectedSuperItems      <Collection>           collection of superItems derived from selection
+
+        tabHolder               <ValueHolder>          selected tab label holder
+        notifyDisabledCounter   <SmallInteger>         ~~ 0 than change notifications are discard
+        wizards                 <IdentityDictionary>   keeps all created wizard dialogs
+
+        dropOverLine            <nil or SmallInteger>  nil: drop context not dropabel.
+                                                       = 0: drop context dropable but no item specified
+                                                       ~ 0: drop context dropable for item at lineNumber
+                                                       used t6o restore drop indication drawings
 
     [Class variables:]
-	ImageRetrieverClasses   <Collection>        sorted collection of image receivers
+        ImageRetrieverClasses   <Collection>        sorted collection of image receivers
 
     [start with:]
-	MenuEditor open
-	MenuEditor openOnClass:MenuEditor andSelector:#menu
+        MenuEditor open
+        MenuEditor openOnClass:MenuEditor andSelector:#menu
 
     [author:]
-	Claus Atzkern, eXept Software AG
-	Thomas Zwick, eXept Software AG
+        Claus Atzkern, eXept Software AG
+        Thomas Zwick, eXept Software AG
 "
 ! !