Skip to content
Permalink
Browse files

Merge pull request #773 from jecisc/Add-package-comments

Add-package-comments
  • Loading branch information...
jecisc committed Sep 11, 2019
2 parents e65f229 + 53280e3 commit 20ffe7a65b2743fa805f101c35579b77d33a1119
Showing with 220 additions and 84 deletions.
  1. +30 −58 src/BaselineOfSpec2/BaselineOfSpec2.class.st
  2. +5 −1 src/Spec2-Adapters-Morphic/ManifestSpec2AdaptersMorphic.class.st
  3. +12 −0 src/Spec2-Adapters-Stub/ManifestSpec2AdaptersStub.class.st
  4. +12 −0 src/Spec2-Backend-Tests/ManifestSpec2BackendTests.class.st
  5. +12 −0 src/Spec2-CommandLine/ManifestSpec2CommandLine.class.st
  6. +12 −0 src/Spec2-Commander2-ContactBook-Extensions/ManifestSpec2Commander2ContactBookExtensions.class.st
  7. +12 −0 src/Spec2-Commander2-ContactBook/ManifestSpec2Commander2ContactBook.class.st
  8. +12 −0 src/Spec2-Commander2-Tests/ManifestSpec2CommanderTests.class.st
  9. +14 −0 src/Spec2-Commander2/ManifestSpec2Commander2.class.st
  10. +12 −0 src/Spec2-Commands/ManifestSpec2Commands.class.st
  11. +0 −12 src/Spec2-Commands/SpMenuGroupPresenter.extension.st
  12. +0 −8 src/Spec2-Commands/SpMenuItemPresenter.extension.st
  13. +5 −1 src/Spec2-Core/ManifestSpec2Core.class.st
  14. +11 −0 src/Spec2-Core/SpMenuGroupPresenter.class.st
  15. +7 −0 src/Spec2-Core/SpMenuItemPresenter.class.st
  16. +12 −0 src/Spec2-Examples/ManifestSpec2Examples.class.st
  17. +1 −1 src/Spec2-Examples/SpInputTextDropList.extension.st
  18. +5 −1 src/Spec2-Help/ManifestSpec2Help.class.st
  19. +12 −0 src/Spec2-Interactions/ManifestSpec2Interactions.class.st
  20. +5 −1 src/Spec2-Layout/ManifestSpec2Layout.class.st
  21. +12 −0 src/Spec2-Morphic-Backend-Tests/ManifestSpec2MorphicBackendTests.class.st
  22. +5 −1 src/Spec2-Tests/ManifestSpec2Tests.class.st
  23. +12 −0 src/Spec2-Transmission/ManifestSpec2Transmission.class.st
@@ -9,82 +9,54 @@ BaselineOfSpec2 >> baseline: spec [
<baseline>
spec
for: #common
do: [

self commander2: spec.
do: [ self commander2: spec.

"Packages"
spec
package: 'Spec2-Core'
with: [ spec requires: #('Spec2-Layout' 'Spec2-Transmission') ];
package: 'Spec2-CommandLine'
with: [ spec requires: #('Spec2-Core') ];
package: 'Spec2-Core' with: [ spec requires: #('Spec2-Layout' 'Spec2-Transmission' 'Spec2-Commands') ];
package: 'Spec2-CommandLine' with: [ spec requires: #('Spec2-Core') ];
package: 'Spec2-Help';
package: 'Spec2-Commands'
with: [ spec requires: #('Spec2-Core') ];
package: 'Spec2-Deprecated'
with: [ spec
requires: #('Spec2-Tests' 'Spec2-Adapters-Morphic' 'Spec2-Commander2') ];
package: 'Spec2-Commands' with: [ spec requires: #('Commander2') ];
package: 'Spec2-Deprecated' with: [ spec requires: #('Spec2-Tests' 'Spec2-Adapters-Morphic' 'Spec2-Commander2') ];
package: 'Spec2-Layout';
package: 'Spec2-Transmission';
package: 'Spec2-Adapters-Morphic'
with: [ spec requires: #('Spec2-Core') ];
package: 'Spec2-Adapters-Stub'
with: [ spec requires: #('Spec2-Core') ];
package: 'Spec2-Adapters-Morphic' with: [ spec requires: #('Spec2-Core') ];
package: 'Spec2-Adapters-Stub' with: [ spec requires: #('Spec2-Core') ];
package: 'Spec2-Examples';
package: 'Spec2-Interactions'
with: [ spec requires: #('Spec2-Core') ];
package: 'Spec2-Commander2'
with: [ spec requires: #('Spec2-Core' 'Spec2-Interactions' 'Commander2') ];
package: 'Spec2-Commander2-Compatibility'
with: [ spec requires: #('Spec2-Commander2') ];
package: 'Spec2-Commander2-Tests'
with: [ spec requires: #('Spec2-Commander2') ];
package: 'Spec2-Commander2-ContactBook'
with: [ spec requires: #('Spec2-Commander2') ];
package: 'Spec2-Commander2-ContactBook-Extensions'
with: [ spec requires: #('Spec2-Commander2-ContactBook') ];
package: 'Spec2-Tests'
with: [ spec requires: #('Spec2-Examples') ];
package: 'Spec2-Morphic-Backend-Tests'
with: [ spec requires: #('Spec2-Adapters-Morphic') ];
package: 'Spec2-Backend-Tests'
with: [ spec requires: #('Spec2-Adapters-Morphic') ];
package: 'Spec2-Compatibility-Tests'
with: [ spec requires: #('Spec2-Morphic-Backend-Tests' 'Spec2-Deprecated') ]].

package: 'Spec2-Interactions' with: [ spec requires: #('Spec2-Core') ];
package: 'Spec2-Commander2' with: [ spec requires: #('Spec2-Core' 'Spec2-Interactions' 'Commander2') ];
package: 'Spec2-Commander2-Compatibility' with: [ spec requires: #('Spec2-Commander2') ];
package: 'Spec2-Commander2-Tests' with: [ spec requires: #('Spec2-Commander2') ];
package: 'Spec2-Commander2-ContactBook' with: [ spec requires: #('Spec2-Commander2') ];
package: 'Spec2-Commander2-ContactBook-Extensions' with: [ spec requires: #('Spec2-Commander2-ContactBook') ];
package: 'Spec2-Tests' with: [ spec requires: #('Spec2-Examples') ];
package: 'Spec2-Morphic-Backend-Tests' with: [ spec requires: #('Spec2-Adapters-Morphic') ];
package: 'Spec2-Backend-Tests' with: [ spec requires: #('Spec2-Adapters-Morphic') ];
package: 'Spec2-Compatibility-Tests' with: [ spec requires: #('Spec2-Morphic-Backend-Tests' 'Spec2-Deprecated') ] ].

spec
for: #'pharo7.x'
do: [
"Dependencies for Pharo7"
self parametrizedTests: spec.
do: [ "Dependencies for Pharo7"
self parametrizedTests: spec.

spec
baseline: 'Commander'
with: [
spec
spec
baseline: 'Commander'
with: [ spec
repository: 'github://pharo-ide/Commander:v0.8.1/src';
loads: #('Commander-Spec2-Compatibility') ].

spec
package: 'Spec2-Pharo7To8Compatibility';
package: 'Spec2-Backend-Tests'
with: [ spec requires: #('ParametrizedTests' 'Spec2-Adapters-Morphic') ];
package: 'Spec2-Morphic-Backend-Tests'
with: [ spec requires: #('ParametrizedTests' 'Spec2-Adapters-Morphic') ];
package: 'Spec2-Tests'
with: [ spec requires: #('Spec2-Examples' 'ParametrizedTests') ] ].
package: 'Spec2-Backend-Tests' with: [ spec requires: #('ParametrizedTests' 'Spec2-Adapters-Morphic') ];
package: 'Spec2-Morphic-Backend-Tests' with: [ spec requires: #('ParametrizedTests' 'Spec2-Adapters-Morphic') ];
package: 'Spec2-Tests' with: [ spec requires: #('Spec2-Examples' 'ParametrizedTests') ] ].
spec
for: #'pharo8.x'
do: [ spec
package: 'Spec2-Tools'
with: [ spec requires: #('Spec2-Core') ];
package: 'Spec2-Tools-Tests'
with: [ spec requires: #('Spec2-Tests' 'Spec2-Tools') ];
package: 'Spec2-Examples'
with: [ spec requires: #('Spec2-Tools') ];
package: 'Spec2-Deprecated-Tools'
with: [ spec requires: #('Spec2-Deprecated' 'Spec2-Tools') ] ]
package: 'Spec2-Tools' with: [ spec requires: #('Spec2-Core') ];
package: 'Spec2-Tools-Tests' with: [ spec requires: #('Spec2-Tests' 'Spec2-Tools') ];
package: 'Spec2-Examples' with: [ spec requires: #('Spec2-Tools') ];
package: 'Spec2-Deprecated-Tools' with: [ spec requires: #('Spec2-Deprecated' 'Spec2-Tools') ] ]
]

{ #category : #dependencies }
@@ -1,5 +1,9 @@
"
Morphic specific spec adapters
I am a package part of the Spec 2 project.

Spec is a framework in Pharo for describing user interfaces. It allows for the construction of a wide variety of UIs; from small windows with a few but- tons up to complex tools like a debugger. Indeed, multiple tools in Pharo are written in Spec, e.g., Iceberg, Change Sorter, Critics Browser, and the Pharo debugger.

I am implementing the spec layer between presenters and the morphic widgets. I will be used when the morphic backend of Spec is selected to build the Morphic widgets during the GUI creation.
"
Class {
#name : #ManifestSpec2AdaptersMorphic,
@@ -0,0 +1,12 @@
"
I am a package part of the Spec 2 project.

Spec is a framework in Pharo for describing user interfaces. It allows for the construction of a wide variety of UIs; from small windows with a few but- tons up to complex tools like a debugger. Indeed, multiple tools in Pharo are written in Spec, e.g., Iceberg, Change Sorter, Critics Browser, and the Pharo debugger.

I contain stubs adapter to test Spec without any backend.
"
Class {
#name : #ManifestSpec2AdaptersStub,
#superclass : #PackageManifest,
#category : #'Spec2-Adapters-Stub-Manifest'
}
@@ -0,0 +1,12 @@
"
I am a package part of the Spec 2 project.

Spec is a framework in Pharo for describing user interfaces. It allows for the construction of a wide variety of UIs; from small windows with a few but- tons up to complex tools like a debugger. Indeed, multiple tools in Pharo are written in Spec, e.g., Iceberg, Change Sorter, Critics Browser, and the Pharo debugger.

I contain backend specific tests for Spec2.
"
Class {
#name : #ManifestSpec2BackendTests,
#superclass : #PackageManifest,
#category : #'Spec2-Backend-Tests-Manifest'
}
@@ -0,0 +1,12 @@
"
I am a package part of the Spec 2 project.

Spec is a framework in Pharo for describing user interfaces. It allows for the construction of a wide variety of UIs; from small windows with a few but- tons up to complex tools like a debugger. Indeed, multiple tools in Pharo are written in Spec, e.g., Iceberg, Change Sorter, Critics Browser, and the Pharo debugger.

I contain command line useful for Spec. With them the user will be able to do things such as browsing the applications present in the image or launch an application in headless when the backend used is not the Pharo one.
"
Class {
#name : #ManifestSpec2CommandLine,
#superclass : #PackageManifest,
#category : #'Spec2-CommandLine-Manifest'
}
@@ -0,0 +1,12 @@
"
I am a package part of the Spec 2 project.

Spec is a framework in Pharo for describing user interfaces. It allows for the construction of a wide variety of UIs; from small windows with a few but- tons up to complex tools like a debugger. Indeed, multiple tools in Pharo are written in Spec, e.g., Iceberg, Change Sorter, Critics Browser, and the Pharo debugger.

I contain examples of Commander2 integration with Spec.
"
Class {
#name : #ManifestSpec2Commander2ContactBookExtensions,
#superclass : #PackageManifest,
#category : #'Spec2-Commander2-ContactBook-Extensions-Manifest'
}
@@ -0,0 +1,12 @@
"
I am a package part of the Spec 2 project.

Spec is a framework in Pharo for describing user interfaces. It allows for the construction of a wide variety of UIs; from small windows with a few but- tons up to complex tools like a debugger. Indeed, multiple tools in Pharo are written in Spec, e.g., Iceberg, Change Sorter, Critics Browser, and the Pharo debugger.

I contain examples of Commander2 integration with Spec.
"
Class {
#name : #ManifestSpec2Commander2ContactBook,
#superclass : #PackageManifest,
#category : #'Spec2-Commander2-ContactBook-Manifest'
}
@@ -0,0 +1,12 @@
"
I am a package part of the Spec 2 project.

Spec is a framework in Pharo for describing user interfaces. It allows for the construction of a wide variety of UIs; from small windows with a few but- tons up to complex tools like a debugger. Indeed, multiple tools in Pharo are written in Spec, e.g., Iceberg, Change Sorter, Critics Browser, and the Pharo debugger.

I contain test about the integration of Commander 2 in Spec.
"
Class {
#name : #ManifestSpec2CommanderTests,
#superclass : #PackageManifest,
#category : #'Spec2-Commander2-Tests-Manifest'
}
@@ -0,0 +1,14 @@
"
I am a package part of the Spec 2 project.

Spec is a framework in Pharo for describing user interfaces. It allows for the construction of a wide variety of UIs; from small windows with a few but- tons up to complex tools like a debugger. Indeed, multiple tools in Pharo are written in Spec, e.g., Iceberg, Change Sorter, Critics Browser, and the Pharo debugger.

I contain a layer of compatibility for the Commander 2 project.

Commander 2 is a project to create commands following the Command design pattern. With the compatibility layer you can add icons or shortcuts to your commands and integrate them easily in your presenters.
"
Class {
#name : #ManifestSpec2Commander2,
#superclass : #PackageManifest,
#category : #'Spec2-Commander2-Manifest'
}
@@ -0,0 +1,12 @@
"
I am a package part of the Spec 2 project.

Spec is a framework in Pharo for describing user interfaces. It allows for the construction of a wide variety of UIs; from small windows with a few but- tons up to complex tools like a debugger. Indeed, multiple tools in Pharo are written in Spec, e.g., Iceberg, Change Sorter, Critics Browser, and the Pharo debugger.

I am a package whose responsibility is to define the commands that will be used by Spec.
"
Class {
#name : #ManifestSpec2Commands,
#superclass : #PackageManifest,
#category : #'Spec2-Commands-Manifest'
}

This file was deleted.

This file was deleted.

@@ -1,5 +1,9 @@
"
Core package for the Spec UI framework
I am a package part of the Spec 2 project.

Spec is a framework in Pharo for describing user interfaces. It allows for the construction of a wide variety of UIs; from small windows with a few but- tons up to complex tools like a debugger. Indeed, multiple tools in Pharo are written in Spec, e.g., Iceberg, Change Sorter, Critics Browser, and the Pharo debugger.

I contain the core of Spec 2. By core I mean all the code defining the basics of Spec and the basic widgets users should use to build their applications.
"
Class {
#name : #ManifestSpec2Core,
@@ -33,6 +33,17 @@ SpMenuGroupPresenter class >> adapterName [
^ #MenuGroupAdapter
]

{ #category : #private }
SpMenuGroupPresenter >> add: aName target: targetObject selector: aSelector [

self flag: #TODO. "This is for compatibility with the old menu builder and needs to be removed!"
self addItem: [ :item |
item
name: aName;
action: [ targetObject perform: aSelector ] ].
^ self menuItems last
]

{ #category : #api }
SpMenuGroupPresenter >> addItem: aBlock [
| item |
@@ -119,6 +119,13 @@ SpMenuItemPresenter >> isMenuPresenter [
^ true
]

{ #category : #accessing }
SpMenuItemPresenter >> keyText: aString [

self flag: #TODO. "This is for backward compatibility and needs to be removed!"
self shortcut: aString first meta
]

{ #category : #api }
SpMenuItemPresenter >> name [
^ name
@@ -0,0 +1,12 @@
"
I am a package part of the Spec 2 project.

Spec is a framework in Pharo for describing user interfaces. It allows for the construction of a wide variety of UIs; from small windows with a few but- tons up to complex tools like a debugger. Indeed, multiple tools in Pharo are written in Spec, e.g., Iceberg, Change Sorter, Critics Browser, and the Pharo debugger.

I contain examples of Spec usages.
"
Class {
#name : #ManifestSpec2Examples,
#superclass : #PackageManifest,
#category : #'Spec2-Examples-Manifest'
}
@@ -1,7 +1,7 @@
Extension { #name : #SpInputTextDropList }

{ #category : #'*Spec2-Examples' }
SpInputTextDropList classSide >> example [
SpInputTextDropList class >> example [
<sampleInstance>
| example |
example := self new
@@ -1,5 +1,9 @@
"
Help descriptions for Spec UI framework
I am a package part of the Spec 2 project.

Spec is a framework in Pharo for describing user interfaces. It allows for the construction of a wide variety of UIs; from small windows with a few but- tons up to complex tools like a debugger. Indeed, multiple tools in Pharo are written in Spec, e.g., Iceberg, Change Sorter, Critics Browser, and the Pharo debugger.

I contain help for the HelpBrowser explaining how to use Spec 2.
"
Class {
#name : #ManifestSpec2Help,
@@ -0,0 +1,12 @@
"
I am a package part of the Spec 2 project.

Spec is a framework in Pharo for describing user interfaces. It allows for the construction of a wide variety of UIs; from small windows with a few but- tons up to complex tools like a debugger. Indeed, multiple tools in Pharo are written in Spec, e.g., Iceberg, Change Sorter, Critics Browser, and the Pharo debugger.

I contain code to manage interactions with the user.
"
Class {
#name : #ManifestSpec2Interactions,
#superclass : #PackageManifest,
#category : #'Spec2-Interactions-Manifest'
}
@@ -1,5 +1,9 @@
"
Layouts and layout actions for Spec UI framework
I am a package part of the Spec 2 project.

Spec is a framework in Pharo for describing user interfaces. It allows for the construction of a wide variety of UIs; from small windows with a few but- tons up to complex tools like a debugger. Indeed, multiple tools in Pharo are written in Spec, e.g., Iceberg, Change Sorter, Critics Browser, and the Pharo debugger.

I contain the layouts used by presenters to position their elements.
"
Class {
#name : #ManifestSpec2Layout,
@@ -0,0 +1,12 @@
"
I am a package part of the Spec 2 project.

Spec is a framework in Pharo for describing user interfaces. It allows for the construction of a wide variety of UIs; from small windows with a few but- tons up to complex tools like a debugger. Indeed, multiple tools in Pharo are written in Spec, e.g., Iceberg, Change Sorter, Critics Browser, and the Pharo debugger.

I contain the Morphic specific tests of Spec.
"
Class {
#name : #ManifestSpec2MorphicBackendTests,
#superclass : #PackageManifest,
#category : #'Spec2-Morphic-Backend-Tests-Manifest'
}
@@ -1,5 +1,9 @@
"
Package for SUnit tests related to Spec UI framework
I am a package part of the Spec 2 project.

Spec is a framework in Pharo for describing user interfaces. It allows for the construction of a wide variety of UIs; from small windows with a few but- tons up to complex tools like a debugger. Indeed, multiple tools in Pharo are written in Spec, e.g., Iceberg, Change Sorter, Critics Browser, and the Pharo debugger.

I contain the tests of Spec2-Core. Those are the tests of Presenters that are independant of the backend used by the user.
"
Class {
#name : #ManifestSpec2Tests,
@@ -0,0 +1,12 @@
"
I am a package part of the Spec 2 project.

Spec is a framework in Pharo for describing user interfaces. It allows for the construction of a wide variety of UIs; from small windows with a few but- tons up to complex tools like a debugger. Indeed, multiple tools in Pharo are written in Spec, e.g., Iceberg, Change Sorter, Critics Browser, and the Pharo debugger.

I contain the code for a syntactic sugar of Spec allowing the developer to define the flow of its data using transmissions.
"
Class {
#name : #ManifestSpec2Transmission,
#superclass : #PackageManifest,
#category : #'Spec2-Transmission-Manifest'
}

0 comments on commit 20ffe7a

Please sign in to comment.
You can’t perform that action at this time.