#DOCUMENTATION by cg
authorClaus Gittinger <cg@exept.de>
Mon, 04 Dec 2017 17:43:06 +0100
changeset 22387 9f14f5b840d0
parent 22386 a48531ebacd3
child 22388 a7392e0e7e23
#DOCUMENTATION by cg class: ProjectDefinition class comment/format in: #basicFileNamesToGenerate #fileNamesToGenerate #forEachFileNameAndGeneratedContentsDo: #forEachFileNameAndGeneratorMethodDo:
ProjectDefinition.st
--- a/ProjectDefinition.st	Fri Dec 01 13:37:50 2017 +0100
+++ b/ProjectDefinition.st	Mon Dec 04 17:43:06 2017 +0100
@@ -2895,7 +2895,6 @@
     "Created: / 18-08-2006 / 12:51:38 / cg"
 ! !
 
-
 !ProjectDefinition class methodsFor:'description - project information'!
 
 applicationAdditionalIconFileNames
@@ -3436,7 +3435,7 @@
 !
 
 basicFileNamesToGenerate
-    "answer a dictionary (filename -> generator method) with all the files,
+    "answer a dictionary (filename -> generator method) with all the build-support files,
      that have to be generated for this package"
 
     | dict cls |
@@ -3461,7 +3460,7 @@
     dict
         at:self rcFilename      put:#'generate_packageName_dot_rc'.             "/ for windows
 
-    "Add additional custom files"
+    "Add additional custom files as specified in file:overwrite: annotations"
     cls := self.
     [ cls ~~ Object ] whileTrue:[
         cls class selectorsAndMethodsDo:[:selector :method |
@@ -3478,27 +3477,29 @@
     ^ dict.
 
     "
-    stx_libbasic basicFileNamesToGenerate
-    stx_libjava basicFileNamesToGenerate
-    "
-
-    "Modified (comment): / 05-09-2012 / 19:43:07 / cg"
+     stx_libbasic basicFileNamesToGenerate
+     stx_libjava basicFileNamesToGenerate
+    "
+
     "Modified: / 19-01-2015 / 16:33:25 / Jan Vrany <jan.vrany@fit.cvut.cz>"
+    "Modified (comment): / 04-12-2017 / 17:40:03 / cg"
 !
 
 fileNamesToGenerate
-    "answer the files that have to be generated as a dictionary of names and generator method"
+    "answer the build-support files that have to be generated as a dictionary of names and generator method"
 
     ^ self basicFileNamesToGenerate removeAllKeys:self protectedFileNames ifAbsent:[]
 
     "
       stx_libbasic fileNamesToGenerate
     "
+
+    "Modified (comment): / 04-12-2017 / 17:40:23 / cg"
 !
 
 forEachFileNameAndGeneratedContentsDo:aTwoArgBlock
     "for build-support file generation, checkin etc., use this common method which
-     enumerates all fileNames with their generated contents to be built."
+     enumerates all build-support fileNames with their generated contents to be built."
 
     |pairs|
 
@@ -3516,14 +3517,16 @@
 
     "Created: / 16-08-2006 / 18:37:52 / User"
     "Modified: / 19-01-2015 / 16:58:01 / Jan Vrany <jan.vrany@fit.cvut.cz>"
+    "Modified (comment): / 04-12-2017 / 17:40:49 / cg"
 !
 
 forEachFileNameAndGeneratorMethodDo:aTwoArgBlock
-    "helper for build-support file generation"
+    "helper for build-support file generation; enumerates all build-support files"
 
     self fileNamesToGenerate keysAndValuesDo:aTwoArgBlock
 
     "Modified: / 14-09-2006 / 21:02:37 / cg"
+    "Modified (comment): / 04-12-2017 / 17:40:39 / cg"
 !
 
 generateFile:filename
@@ -4976,7 +4979,6 @@
     ^ self subProjectMakeCallsUsing:'call vcmake %1 %2'.
 ! !
 
-
 !ProjectDefinition class methodsFor:'file templates'!
 
 autopackage_default_dot_apspec