#DOCUMENTATION by cg
authorClaus Gittinger <cg@exept.de>
Wed, 06 Feb 2019 18:19:18 +0100
changeset 23671 bb9ad1ca0117
parent 23670 12331a3a54a0
child 23672 af737017e287
#DOCUMENTATION by cg class: MiniLogger class comment/format in:20 methods
MiniLogger.st
--- a/MiniLogger.st	Wed Feb 06 18:02:09 2019 +0100
+++ b/MiniLogger.st	Wed Feb 06 18:19:18 2019 +0100
@@ -77,6 +77,8 @@
         Logger loggingThreshold: Logger severityINFO.
         Logger loggingThreshold: Logger severityNONE.
 
+    ALL > FATAL > ERROR > WARN > INFO > DEBUG > TRACE0 > TRACE3 > NONE
+
     The following keywords are expanded in the message:
         'LINE'      linenumber in the sending method
         'RECEIVER'  printstring of receiver in sending context
@@ -263,93 +265,141 @@
 !MiniLogger class methodsFor:'accessing-severities'!
 
 severities
+    "ALL > FATAL > ERROR > WARN > INFO > DEBUG > TRACE0 > TRACE3 > NONE"
+    
     ^ Severities.
+
+    "Modified (comment): / 06-02-2019 / 18:17:15 / Claus Gittinger"
 !
 
 severityDEBUG
+    "ALL > FATAL > ERROR > WARN > INFO > DEBUG > TRACE0 > TRACE3 > NONE"
+    
     ^ DEBUG
 
     "Created: / 13-08-2014 / 14:15:11 / Jan Vrany <jan.vrany@fit.cvut.cz>"
+    "Modified (comment): / 06-02-2019 / 18:18:21 / Claus Gittinger"
 !
 
 severityENTER
+    "ALL > FATAL > ERROR > WARN > INFO > DEBUG > TRACE0 > TRACE3 > NONE"
+
     ^ ENTER
 
     "Created: / 13-08-2014 / 14:14:06 / Jan Vrany <jan.vrany@fit.cvut.cz>"
+    "Modified (comment): / 06-02-2019 / 18:18:24 / Claus Gittinger"
 !
 
 severityERROR
+    "setting this as treshold will print errors"
+    "ALL > FATAL > ERROR > WARN > INFO > DEBUG > TRACE0 > TRACE3 > NONE"
+
     ^ ERROR
 
     "Created: / 13-08-2014 / 14:15:35 / Jan Vrany <jan.vrany@fit.cvut.cz>"
+    "Modified (comment): / 06-02-2019 / 18:18:30 / Claus Gittinger"
 !
 
 severityFATAL
+    "ALL > FATAL > ERROR > WARN > INFO > DEBUG > TRACE0 > TRACE3 > NONE"
+
     ^ FATAL
 
     "Created: / 13-08-2014 / 14:15:45 / Jan Vrany <jan.vrany@fit.cvut.cz>"
+    "Modified (comment): / 06-02-2019 / 18:18:33 / Claus Gittinger"
 !
 
 severityINFO
+    "ALL > FATAL > ERROR > WARN > INFO > DEBUG > TRACE0 > TRACE3 > NONE"
+
     ^ INFO
 
     "Created: / 13-08-2014 / 14:15:21 / Jan Vrany <jan.vrany@fit.cvut.cz>"
+    "Modified (comment): / 06-02-2019 / 18:18:37 / Claus Gittinger"
 !
 
 severityLEAVE
+    "ALL > FATAL > ERROR > WARN > INFO > DEBUG > TRACE0 > TRACE3 > NONE"
+
     ^ LEAVE
 
     "Created: / 13-08-2014 / 14:14:19 / Jan Vrany <jan.vrany@fit.cvut.cz>"
+    "Modified (comment): / 06-02-2019 / 18:18:40 / Claus Gittinger"
 !
 
 severityTRACE
+    "ALL > FATAL > ERROR > WARN > INFO > DEBUG > TRACE0 > TRACE3 > NONE"
+
     ^ TRACE
 
     "Created: / 13-08-2014 / 14:15:01 / Jan Vrany <jan.vrany@fit.cvut.cz>"
+    "Modified (comment): / 06-02-2019 / 18:18:43 / Claus Gittinger"
 !
 
 severityTRACE0
+    "ALL > FATAL > ERROR > WARN > INFO > DEBUG > TRACE0 > TRACE3 > NONE"
+
     ^ TRACE0
 
     "Created: / 13-08-2014 / 14:14:59 / Jan Vrany <jan.vrany@fit.cvut.cz>"
+    "Modified (comment): / 06-02-2019 / 18:18:45 / Claus Gittinger"
 !
 
 severityTRACE1
+    "ALL > FATAL > ERROR > WARN > INFO > DEBUG > TRACE0 > TRACE3 > NONE"
+
     ^ TRACE1
 
     "Created: / 13-08-2014 / 14:14:56 / Jan Vrany <jan.vrany@fit.cvut.cz>"
+    "Modified (format): / 06-02-2019 / 18:18:51 / Claus Gittinger"
 !
 
 severityTRACE2
+    "ALL > FATAL > ERROR > WARN > INFO > DEBUG > TRACE0 > TRACE3 > NONE"
+
     ^ TRACE2
 
     "Created: / 13-08-2014 / 14:14:53 / Jan Vrany <jan.vrany@fit.cvut.cz>"
+    "Modified (comment): / 06-02-2019 / 18:18:54 / Claus Gittinger"
 !
 
 severityTRACE3
+    "ALL > FATAL > ERROR > WARN > INFO > DEBUG > TRACE0 > TRACE3 > NONE"
+
     ^ TRACE3
 
     "Created: / 13-08-2014 / 14:14:48 / Jan Vrany <jan.vrany@fit.cvut.cz>"
+    "Modified (comment): / 06-02-2019 / 18:18:57 / Claus Gittinger"
 !
 
 severityWARN
+    "setting this as treshold will print warnings and errors"
+    "ALL > FATAL > ERROR > WARN > INFO > DEBUG > TRACE0 > TRACE3 > NONE"
+
     ^ WARN
 
     "Created: / 13-08-2014 / 14:15:30 / Jan Vrany <jan.vrany@fit.cvut.cz>"
+    "Modified (comment): / 06-02-2019 / 18:19:01 / Claus Gittinger"
 ! !
 
 !MiniLogger class methodsFor:'accessing-severities-special'!
 
 severityALL
+    "setting this as treshold will print all"
+
     ^ ALL
 
     "Created: / 13-08-2014 / 14:14:00 / Jan Vrany <jan.vrany@fit.cvut.cz>"
+    "Modified (comment): / 06-02-2019 / 18:14:48 / Claus Gittinger"
 !
 
 severityNONE
+    "setting this as treshold will suppress all logging"
+    
     ^ NONE
 
     "Created: / 13-08-2014 / 14:15:53 / Jan Vrany <jan.vrany@fit.cvut.cz>"
+    "Modified (comment): / 06-02-2019 / 18:14:40 / Claus Gittinger"
 ! !
 
 !MiniLogger class methodsFor:'configuration'!
@@ -378,7 +428,8 @@
     "Sets logging threshold. 
      All severities higher or equal to the given one will be logged.
      Use `Logger severityNONE` to suppress logging completely 
-     or `Logger severityALL` to log all messages"
+     or `Logger severityALL` to log all messages.
+     ALL > FATAL > ERROR > WARN > INFO > DEBUG > TRACE0 > TRACE3 > NONE"
     
     (
         (Severities includes:severity) 
@@ -403,12 +454,13 @@
     "Modified: / 26-08-2014 / 08:23:13 / Jan Vrany <jan.vrany@fit.cvut.cz>"
     "Modified (comment): / 09-10-2014 / 09:35:23 / Jan Vrany <jan.vrany@fit.cvut.cz>"
     "Modified (comment): / 01-03-2017 / 10:42:31 / cg"
-    "Modified (comment): / 06-02-2019 / 17:56:48 / Claus Gittinger"
+    "Modified (comment): / 06-02-2019 / 18:17:57 / Claus Gittinger"
 !
 
 loggingThreshold:aLimitOrNil forClass:aClass
     "allows individual per-class setting of the threshold (useful during debugging).
-     With a nil limit, the default is reinstalled for that class."
+     With a nil limit, the default is reinstalled for that class.
+     ALL > FATAL > ERROR > WARN > INFO > DEBUG > TRACE0 > TRACE3 > NONE"
 
     "/ the original scheme asked the class;
     "/ but that required adding a getter to debugged classes, which
@@ -443,11 +495,13 @@
     "
 
     "Created: / 01-03-2017 / 10:52:25 / cg"
+    "Modified (comment): / 06-02-2019 / 18:18:03 / Claus Gittinger"
 !
 
 loggingThreshold:aLimitOrNil forPackage:aPackageName
     "allows individual per-package setting of the threshold (useful during debugging).
-     With a nil limit, the default is reinstalled for that class."
+     With a nil limit, the default is reinstalled for that class.
+     ALL > FATAL > ERROR > WARN > INFO > DEBUG > TRACE0 > TRACE3 > NONE"
 
     "/ the original scheme only asked the class;
     "/ but that required adding many getters to debugged packages, 
@@ -482,6 +536,7 @@
     "
 
     "Created: / 01-03-2017 / 10:53:42 / cg"
+    "Modified (comment): / 06-02-2019 / 18:18:07 / Claus Gittinger"
 ! !
 
 !MiniLogger class methodsFor:'logging'!
@@ -553,7 +608,7 @@
         "/ [ caller notNil and: [ caller receiver ~~ originator ] ] whileTrue:[ caller := caller sender ].
         "/ self log: 'caller is ', caller printString severity: INFO facility: 'STX' originator: self.
     ] ifFalse:[
-       "/ Now check whether the severity is one of the predefined ones,
+        "/ Now check whether the severity is one of the predefined ones,
         "/ if not, issue an error
         (Severities includesIdentical:severityXlated) ifFalse:[ 
             | caller |
@@ -654,6 +709,7 @@
     "Modified: / 01-03-2017 / 11:15:46 / cg"
     "Modified: / 28-06-2018 / 11:15:42 / Stefan Vogel"
     "Modified: / 10-07-2018 / 00:16:35 / Claus Gittinger"
+    "Modified (format): / 06-02-2019 / 18:12:24 / Claus Gittinger"
 !
 
 log: message severity: severity originator: originator