Merge pull request #1566 from moosetechnology/documentation

Documentation + fix pending #1565

Author: NicolasAnquetil

src/MooseIDE-BulkEditor/MiBulkEditor.class.st

@@ -1,16 +1,17 @@
 "
-Bulk editor on a Java file: comment out a collection of methods
+Bulk editor on Java files: comment out or remove a collection of methods
 Can be applied for example on dead methods:
 - compute all dead methods in a file -> `deadMethodCollection`
 - call: `MiBulkEditor new runOn: deadMethodCollection.`
-- Output the resulting lines in a file
+
+The following will comment out or remove a list of methods from their respective source files
 ```
 bulkEditor := MiBulkEditor new.
-bulkEditor runOn: deadMethods.
-file := 'SomeFile.java' asFileReference.
-file ifExists: [ file delete ].
-file writeStreamDo: [ :st | bulkEditor lines do: [ :line | st << line ; cr ] ].
+bulkEditor runOn: <deadMethodCollection>.
 ```
+
+The default is to comment out the methods: `bulkEditor commentLines`
+The editor can be instructed to remove the methods from their files: `bulkEditor removeLines`
 "
 Class {
 	#name : 'MiBulkEditor',

src/MooseIDE-Famix/MiSourceTextRendererModel.class.st

@@ -86,7 +86,8 @@ MiSourceTextRendererModel >> addKeywordHighlight: anInterval [
 
 { #category : 'highlights' }
 MiSourceTextRendererModel >> clearHighlightsInComments [
-
+	"note: potential issue here as #clearNoncommentHighlightFrom:to: modifies the list of highlights
+	 However, it should remove only non-comment highlights, so in the end there is no harm done"
 	self highlights copy do: [ :highlight |
 		(highlight class = MiSourceTextCommentHighlight)
 			ifTrue: [
@@ -142,6 +143,8 @@ MiSourceTextRendererModel >> createHighlights [
 	self prepareSourceAnchorAdapter.
 	self createKeywordHighlights.
 	self createEntitiesHighlightsFor: entity.
+	"bypassing bug in #createEntitiesHighlightsFor:"
+	self highlights removeAllSuchThat: [ :hglght | hglght hasInterval not  ].
 	self clearHighlightsInComments
 ]
 
@@ -163,7 +166,7 @@ MiSourceTextRendererModel >> createKeywordHighlights [
 { #category : 'highlights' }
 MiSourceTextRendererModel >> createKeywordHighlightsFor: aKeyWord [
 	"Search for a keyword in the displayedText and creates a keyWordHighlight for it
-	 keywords should be whole words (after and before a word separator) or strat the text or end it"
+	 keywords should be whole words (after and before a word separator) or start the text or end it"
 
 	| matcher |
 

src/MooseIDE-Tests/MiSourceTextRendererModelTest.class.st

@@ -129,12 +129,17 @@ MiSourceTextRendererModelTest >> testHighlightChildWithIndexedFileAnchor [
 
 { #category : 'tests - highlighting' }
 MiSourceTextRendererModelTest >> testHighlightChildWithNoAnchor [
+	"Although it uses FamixStClass and FamixStMethod, the code given in sourceAnchor is not
+	 formated as normal Pharo code.
+	 This is not a problem as long the entities' names are found in it"
+
 	| entity |
+
 	entity := FamixStClass new
 		name: 'aClass' ;
 		sourceAnchor: (self stubIndexedAnchorText: 
 'code of aClass {
-	code of aMethod()
+	code of aClass >> aMethod()
 }').
 	FamixStMethod new
 		name: 'aMethod' ;
@@ -147,10 +152,6 @@ MiSourceTextRendererModelTest >> testHighlightChildWithNoAnchor [
 		self assert: highlight class equals: MiSourceTextIdentifierHighlight
 	].
 
-	"one highlight has an interval, the other not"
-	self assert: (rendererModel highlights anySatisfy: #hasInterval).
-	self assert: (rendererModel highlights anySatisfy: [ :highlight | highlight hasInterval not]).
-
 ]
 
 { #category : 'tests - highlighting' }