Classes to be documented
Last updated at 1:50 am UTC on 26 July 2013
Quite many of the Squeak classes have no class commments or other documentation yet. This swiki does have extra documentation not in the image for a number of classes, see Notes on specific classes.
This page is used for personal requests of class comments and for synchronizing the commenting effort.
updateMe
Comment requests
Please add a line for the particular class you want to see commented. If there is a comment today, indicate what you would like to be improved (more examples, better explanations etc):
Classes without comments
The following code with an "inspect it" on this code (in a 3.2g-4827 image) produces a table without comments:
| classNames categoryPatterns |
classNames := OrderedCollection new.
categoryPatterns := #('Collections-*' 'System-*' '*Kernel*').
categoryPatterns do: [:pat |
(SystemOrganization categoriesMatching: pat) do:
[:cat | (SystemOrganization superclassOrder: cat) do: [:c |
c theNonMetaClass organization classComment isEmpty
ifTrue:[classNames add: c name]]]].
classNames := classNames asSet asSortedCollection.
String streamContents: [:s | classNames do: [:cn | s nextPutAll: '|',
cn, '| |', String cr]].
That gave 94 classes.
The same code adapted for Squeak3.3a-4843:
| classNames |
classNames := OrderedCollection new.
modules := {Module @ #(Squeak Language). Module @ #(Squeak Technology)}.
modules do: [:m |
m deepClassesDo: [:c |
c theNonMetaClass organization classComment isEmpty
ifTrue:[classNames add: c name]]].
classNames := classNames asSet asSortedCollection.
String streamContents: [:s | classNames do: [:cn | s nextPutAll: '|',
cn, '| |', String cr]]
updateMe
This gives 110 classes in 3.3a-4843. (Note that the Language and Technology modules might not be eactly the same as the categories matched above in 3.2g)
If you want to reduce this table a bit and thus becoming a verified Squeak Class Comment Crusader Hero, then:
- Mark class with [yyyy-mm-dd]Your email if you intend to write a comment.
- Write the comment(s), you have 1 week to do it, after that it's open season to remove your mark in this table!
- Submit the comment(s) to the list (as described elsewhere on this Swiki) exactly as "[FIX]CommentCrusade:XXX" (then we harvesters recognize it as only comments and can fasttrack it a bit).
- When you have submitted the comment to the list - go back here and add the word "SUBMITTED" after your email.
If there is something special about any of these classes - write a note in the table.
| AssertionFailure | [2002-05-02]goran.hultgren@bluefish.se SUBMITTED |
| AttemptToWriteReadOnlyGlobal | [2002-05-02]goran.hultgren@bluefish.se SUBMITTED |
| Month | [2002-04-18]goran.hultgren@bluefish.se SUBMITTED |
| TarArchive | [2002-04-20] hannes.hirzel.squeaklist@bluewin.ch |
| TextStream | hannes.hirzel.squeaklist@bluewin.ch |
