add documentation in CustomNewClassGenerator
authorJakub Nesveda <jakubnesveda@seznam.cz>
Sun, 09 Nov 2014 01:25:55 +0100
changeset 738 3c27b65f02bf
parent 737 dbbad959994f
child 739 45b418be7fa1
add documentation in CustomNewClassGenerator
CustomNewClassGenerator.st
--- a/CustomNewClassGenerator.st	Sun Nov 09 01:12:04 2014 +0100
+++ b/CustomNewClassGenerator.st	Sun Nov 09 01:25:55 2014 +0100
@@ -7,6 +7,17 @@
 	category:'Interface-Refactoring-Custom-Generators'
 !
 
+!CustomNewClassGenerator class methodsFor:'documentation'!
+
+documentation
+"
+    Template class for generators which needs to create a new class.
+
+    [author:]
+        Jakub Nesveda <nesvejak@fit.cvut.cz>
+"
+! !
+
 !CustomNewClassGenerator class methodsFor:'queries'!
 
 availableInContext:aCustomContext
@@ -34,40 +45,52 @@
 !CustomNewClassGenerator methodsFor:'accessing'!
 
 newClassName
+    "Returns a name of the new class to be created."
+
     ^ newClassName
 
     "Created: / 08-11-2014 / 16:58:42 / Jakub Nesveda <nesvejak@fit.cvut.cz>"
+    "Modified (comment): / 09-11-2014 / 01:20:23 / Jakub Nesveda <nesvejak@fit.cvut.cz>"
 !
 
-newClassName:aClassName
+newClassName: aClassName
+    "see newClassName"
+
     newClassName := aClassName.
 
     "Created: / 08-11-2014 / 16:59:01 / Jakub Nesveda <nesvejak@fit.cvut.cz>"
+    "Modified (comment): / 09-11-2014 / 01:20:41 / Jakub Nesveda <nesvejak@fit.cvut.cz>"
 ! !
 
 !CustomNewClassGenerator methodsFor:'accessing - ui'!
 
 defaultClassName
+    "Returns class name which will be displayed in dialog input box"
 
     self subclassResponsibility
 
     "Created: / 08-11-2014 / 16:56:50 / Jakub Nesveda <nesvejak@fit.cvut.cz>"
+    "Modified (comment): / 09-11-2014 / 01:21:51 / Jakub Nesveda <nesvejak@fit.cvut.cz>"
 !
 
 newClassNameLabel
+    "Returns a label of the dialog for the new class to be created"
 
     self subclassResponsibility
 
     "Created: / 08-11-2014 / 16:57:41 / Jakub Nesveda <nesvejak@fit.cvut.cz>"
+    "Modified (comment): / 09-11-2014 / 01:22:42 / Jakub Nesveda <nesvejak@fit.cvut.cz>"
 ! !
 
 !CustomNewClassGenerator methodsFor:'executing - private'!
 
 buildForClass: aClass
+    "Subclass can modify the newly created class in here"
 
     self subclassResponsibility
 
     "Created: / 08-11-2014 / 17:06:04 / Jakub Nesveda <nesvejak@fit.cvut.cz>"
+    "Modified (comment): / 09-11-2014 / 01:24:07 / Jakub Nesveda <nesvejak@fit.cvut.cz>"
 !
 
 buildInContext:aCustomContext
@@ -101,3 +124,10 @@
     "Created: / 08-11-2014 / 17:01:29 / Jakub Nesveda <nesvejak@fit.cvut.cz>"
 ! !
 
+!CustomNewClassGenerator class methodsFor:'documentation'!
+
+version_HG
+
+    ^ '$Changeset: <not expanded> $'
+! !
+