[Pharo-project] What is a well documented class?

Alexandre Bergel alexandre.bergel at me.com
Tue Apr 26 15:27:06 CEST 2011


> What would be a "casual user" of a class in Smalltalk?

Someone who does not care about the type of instances variables of that particular class :-)

Alexandre

> 
> 
> Em 25/04/2011 18:19, Alexandre Bergel < alexandre.bergel at me.com > escreveu:
> Ok, focusing on the instance variables. I think there is two kind of documentation, one for the casual user, and another for the developers. 
> 
> Alexandre
> 
> 
> On 25 Apr 2011, at 16:09, DougEdmunds wrote:
> 
>> 2cents about "what is a well-documented class?": 
>> 
>> Information about the state variables (instance variables): what goes in the
>> slot, and what it's for.
>> 
>> Good examples (the layout gets skewed doing copy/paste)
>> 
>> in RxsPredicate
>> 
>> Instance Variables:
>> 
>> 	predicate		A one-argument block. If it evaluates to the value
>> defined by 
>> when it is passed a character, the predicate is considered to
>> match.
>> 
>> 	negation		A one-argument block that is a negation of
>> .
>> 
>> 
>> SMxMorph 
>> 
>> Structure:
>> instance var 	Type 			Description 
>> bounds 		Rectangle 		A Rectangle indicating my position and a size that will
>> enclose 									me. 
>> 
>> owner 		SMxMorph		 	My parent SMxMorph, or nil for the top-level SMxMorph,
>> which is a
>> 				or nil			world, typically a SMxPasteUpMorph.
>> 
>> submorphs 		Array 			My child Morphs. 
>> 
>> fullBounds 		Rectangle 		A Rectangle minimally enclosing me and my
>> submorphs. 
>> 
>> color 			Color 			My primary color. Subclasses can use this in different
>> ways. 
>> 
>> extension 		SMxMorphExtension Allows extra properties to be stored without
>> adding a
>> 				or nil  				storage burden to all morphs. 
>> 
>> 
>> --
>> View this message in context: http://forum.world.st/What-is-a-well-documented-class-tp3470956p3474024.html
>> Sent from the Pharo Smalltalk mailing list archive at Nabble.com.
>> 
> 
> -- 
> _,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;:
> Alexandre Bergel  http://www.bergel.eu
> ^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;.
> 
> 
> 
> 
> 
> 
> 
> 

-- 
_,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;:
Alexandre Bergel  http://www.bergel.eu
^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;.








More information about the Pharo-project mailing list