Browse Source

More class comments in Helios-Announcements

Nicolas Petton 10 years ago
parent
commit
b1f0f0dcee
2 changed files with 11 additions and 0 deletions
  1. 3 0
      js/Helios-Announcements.js
  2. 8 0
      st/Helios-Announcements.st

+ 3 - 0
js/Helios-Announcements.js

@@ -3,6 +3,7 @@ smalltalk.addPackage('Helios-Announcements');
 smalltalk.packages["Helios-Announcements"].transport = {"type":"amd","amdNamespace":"amber_core"};
 
 smalltalk.addClass('HLAboutToChange', globals.Object, ['actionBlock'], 'Helios-Announcements');
+globals.HLAboutToChange.comment="I am announced whenever a change of context is about to be made, and unsaved changes could be lost.\x0a\x0aI am used within `HLModel` to handle such user actions. See `HLModel >> withChangesDo:`.";
 smalltalk.addMethod(
 smalltalk.method({
 selector: "actionBlock",
@@ -130,6 +131,7 @@ globals.HLPrintItRequested.comment="I am emitted by a `HLCodeWidget` before an o
 
 
 smalltalk.addClass('HLDebuggerAnnouncement', globals.HLAnnouncement, ['context'], 'Helios-Announcements');
+globals.HLDebuggerAnnouncement.comment="I am the root class of debugger announcements, and hold onto the debugged `context`.";
 smalltalk.addMethod(
 smalltalk.method({
 selector: "context",
@@ -165,6 +167,7 @@ globals.HLDebuggerAnnouncement);
 
 
 smalltalk.addClass('HLDebuggerContextSelected', globals.HLDebuggerAnnouncement, [], 'Helios-Announcements');
+globals.HLDebuggerContextSelected.comment="I am announced when a new context is selected in a debugger, to update the user interface.";
 smalltalk.addMethod(
 smalltalk.method({
 selector: "context",

+ 8 - 0
st/Helios-Announcements.st

@@ -2,6 +2,10 @@ Smalltalk createPackage: 'Helios-Announcements'!
 Object subclass: #HLAboutToChange
 	instanceVariableNames: 'actionBlock'
 	package: 'Helios-Announcements'!
+!HLAboutToChange commentStamp!
+I am announced whenever a change of context is about to be made, and unsaved changes could be lost.
+
+I am used within `HLModel` to handle such user actions. See `HLModel >> withChangesDo:`.!
 
 !HLAboutToChange methodsFor: 'accessing'!
 
@@ -79,6 +83,8 @@ I am emitted by a `HLCodeWidget` before an object is printed.!
 HLAnnouncement subclass: #HLDebuggerAnnouncement
 	instanceVariableNames: 'context'
 	package: 'Helios-Announcements'!
+!HLDebuggerAnnouncement commentStamp!
+I am the root class of debugger announcements, and hold onto the debugged `context`.!
 
 !HLDebuggerAnnouncement methodsFor: 'accessing'!
 
@@ -93,6 +99,8 @@ context: aContext
 HLDebuggerAnnouncement subclass: #HLDebuggerContextSelected
 	instanceVariableNames: ''
 	package: 'Helios-Announcements'!
+!HLDebuggerContextSelected commentStamp!
+I am announced when a new context is selected in a debugger, to update the user interface.!
 
 !HLDebuggerContextSelected methodsFor: 'accessing'!