Added documentation for the contact book.

Author: juliendelplanque

Lieutenant-ContactBook/LtAddContactCommand.class.st

@@ -1,10 +1,9 @@
+"
+I am a command allowing to add a contact.
+"
 Class {
 	#name : #LtAddContactCommand,
 	#superclass : #LtContactBookCommand,
-	#instVars : [
-		'contactName',
-		'contactPhone'
-	],
 	#category : #'Lieutenant-ContactBook-Commands'
 }
 
@@ -18,26 +17,6 @@ LtAddContactCommand >> asSpecCommand [
 		yourself
 ]
 
-{ #category : #accessing }
-LtAddContactCommand >> contactName [
-	^ contactName
-]
-
-{ #category : #accessing }
-LtAddContactCommand >> contactName: anObject [
-	contactName := anObject
-]
-
-{ #category : #accessing }
-LtAddContactCommand >> contactPhone [
-	^ contactPhone
-]
-
-{ #category : #accessing }
-LtAddContactCommand >> contactPhone: anObject [
-	contactPhone := anObject
-]
-
 { #category : #hooks }
 LtAddContactCommand >> execute [
 	"One should never manipulate UI directly from a commande.

Lieutenant-ContactBook/LtContact.class.st

@@ -1,3 +1,6 @@
+"
+I model a contact, I have a name and a phone.
+"
 Class {
 	#name : #LtContact,
 	#superclass : #Object,

Lieutenant-ContactBook/LtContactBook.class.st

@@ -1,3 +1,6 @@
+"
+I am a contact book. I hold a list of contacts.
+"
 Class {
 	#name : #LtContactBook,
 	#superclass : #Object,

Lieutenant-ContactBook/LtContactBookCommand.class.st

@@ -1,3 +1,8 @@
+"
+I am an abstract command for the contact book example.
+
+I define methods to access information in my #context more easily.
+"
 Class {
 	#name : #LtContactBookCommand,
 	#superclass : #LtCommand,

Lieutenant-ContactBook/LtContactBookPresenter.class.st

@@ -1,3 +1,10 @@
+"
+I am a presenter for a contact book.
+
+I provide a nice UI to manage the contacts of the contact book I am opened on.
+
+Check my class-side for example.
+"
 Class {
 	#name : #LtContactBookPresenter,
 	#superclass : #ComposablePresenter,

Lieutenant-ContactBook/LtRemoveContactCommand.class.st

@@ -1,3 +1,6 @@
+"
+I am a command allowing to remove a contact.
+"
 Class {
 	#name : #LtRemoveContactCommand,
 	#superclass : #LtContactBookCommand,

Lieutenant-ContactBook/LtRenameContactCommand.class.st

@@ -1,9 +1,9 @@
+"
+I am a command allowing to rename a contact.
+"
 Class {
 	#name : #LtRenameContactCommand,
 	#superclass : #LtContactBookCommand,
-	#instVars : [
-		'newName'
-	],
 	#category : #'Lieutenant-ContactBook-Commands'
 }
 
@@ -35,13 +35,3 @@ LtRenameContactCommand >> initialize [
 		basicName: 'Rename'; "This is the name of the command that will be shown to user."
 		basicDescription: 'Rename the selected contact.'. "This is the description of the command that will be shown to user."
 ]
-
-{ #category : #accessing }
-LtRenameContactCommand >> newName [
-	^ newName
-]
-
-{ #category : #accessing }
-LtRenameContactCommand >> newName: anObject [
-	newName := anObject
-]