Skip to content

Commit

Permalink
Regenerate entity class comments
Browse files Browse the repository at this point in the history
  • Loading branch information
Gabriel-Darbord committed Feb 1, 2024
1 parent 073d8b8 commit 85123b0
Show file tree
Hide file tree
Showing 9 changed files with 157 additions and 0 deletions.
16 changes: 16 additions & 0 deletions src/Famix-UnitTest-Entities/FamixUTAct.class.st
Original file line number Diff line number Diff line change
@@ -1,5 +1,21 @@
"
Execution of the system under test.
## Relations
======================
### Parents
| Relation | Origin | Opposite | Type | Comment |
|---|
| `method` | `FamixUTAct` | `act` | `FamixUTMethod` | |
### Other
| Relation | Origin | Opposite | Type | Comment |
|---|
| `arguments` | `FamixUTAct` | `argumentInAct` | `FamixValueOfType` | |
"
Class {
#name : #FamixUTAct,
Expand Down
22 changes: 22 additions & 0 deletions src/Famix-UnitTest-Entities/FamixUTAssertion.class.st
Original file line number Diff line number Diff line change
@@ -1,5 +1,27 @@
"
Verifies that the behavior or feature being tested behaves as expected.
## Relations
======================
### Parents
| Relation | Origin | Opposite | Type | Comment |
|---|
| `method` | `FamixUTAssertion` | `assertions` | `FamixUTMethod` | |
### Other
| Relation | Origin | Opposite | Type | Comment |
|---|
| `expected` | `FamixUTAssertion` | `expectedInAssertions` | `FamixValueOfType` | |
## Properties
======================
| Name | Type | Default value | Comment |
|---|
| `errorMargin` | `Object` | nil | How much deviation is allowed between the expected and actual values.|
"
Class {
#name : #FamixUTAssertion,
Expand Down
25 changes: 25 additions & 0 deletions src/Famix-UnitTest-Entities/FamixUTCase.class.st
Original file line number Diff line number Diff line change
@@ -1,5 +1,30 @@
"
A class containing test methods.
## Relations
======================
### Parents
| Relation | Origin | Opposite | Type | Comment |
|---|
| `suite` | `FamixUTCase` | `cases` | `FamixUTSuite` | |
### Children
| Relation | Origin | Opposite | Type | Comment |
|---|
| `methods` | `FamixUTCase` | `case` | `FamixUTMethod` | |
### Other
| Relation | Origin | Opposite | Type | Comment |
|---|
| `afterAll` | `FamixUTCase` | `forAllInCase` | `FamixUTTearDown` | |
| `afterEach` | `FamixUTCase` | `forEachInCase` | `FamixUTTearDown` | |
| `beforeAll` | `FamixUTCase` | `forAllInCase` | `FamixUTSetUp` | |
| `beforeEach` | `FamixUTCase` | `forEachInCase` | `FamixUTSetUp` | |
| `testedClass` | `FamixUTCase` | `testCase` | `FamixTClass` | |
"
Class {
#name : #FamixUTCase,
Expand Down
11 changes: 11 additions & 0 deletions src/Famix-UnitTest-Entities/FamixUTFixture.class.st
Original file line number Diff line number Diff line change
@@ -1,5 +1,16 @@
"
Sets up or tears down the system to make tests repeatable.
## Relations
======================
### Other
| Relation | Origin | Opposite | Type | Comment |
|---|
| `values` | `FamixUTFixture` | `fixtures` | `FamixValueOfType` | |
"
Class {
#name : #FamixUTFixture,
Expand Down
30 changes: 30 additions & 0 deletions src/Famix-UnitTest-Entities/FamixUTMethod.class.st
Original file line number Diff line number Diff line change
@@ -1,5 +1,35 @@
"
Tests a specific behavior or feature of the system under test.
## Relations
======================
### Parents
| Relation | Origin | Opposite | Type | Comment |
|---|
| `case` | `FamixUTMethod` | `methods` | `FamixUTCase` | |
### Children
| Relation | Origin | Opposite | Type | Comment |
|---|
| `act` | `FamixUTMethod` | `method` | `FamixUTAct` | |
| `assertions` | `FamixUTMethod` | `method` | `FamixUTAssertion` | |
### Other
| Relation | Origin | Opposite | Type | Comment |
|---|
| `setUp` | `FamixUTMethod` | `method` | `FamixUTSetUp` | |
| `tearDown` | `FamixUTMethod` | `method` | `FamixUTTearDown` | |
| `testedMethod` | `FamixUTMethod` | `unitTests` | `FamixTMethod` | |
## Properties
======================
| Name | Type | Default value | Comment |
|---|
| `name` | `String` | nil | Basic name of the entity, not full reference.|
"
Class {
#name : #FamixUTMethod,
Expand Down
14 changes: 14 additions & 0 deletions src/Famix-UnitTest-Entities/FamixUTSetUp.class.st
Original file line number Diff line number Diff line change
@@ -1,5 +1,19 @@
"
Sets up the system to make tests repeatable.
## Relations
======================
### Other
| Relation | Origin | Opposite | Type | Comment |
|---|
| `forAllInCase` | `FamixUTSetUp` | `beforeAll` | `FamixUTCase` | |
| `forEachInCase` | `FamixUTSetUp` | `beforeEach` | `FamixUTCase` | |
| `method` | `FamixUTSetUp` | `setUp` | `FamixUTMethod` | |
| `suite` | `FamixUTSetUp` | `setUp` | `FamixUTSuite` | |
"
Class {
#name : #FamixUTSetUp,
Expand Down
23 changes: 23 additions & 0 deletions src/Famix-UnitTest-Entities/FamixUTSuite.class.st
Original file line number Diff line number Diff line change
@@ -1,5 +1,28 @@
"
A collection of test cases.
## Relations
======================
### Children
| Relation | Origin | Opposite | Type | Comment |
|---|
| `cases` | `FamixUTSuite` | `suite` | `FamixUTCase` | |
### Other
| Relation | Origin | Opposite | Type | Comment |
|---|
| `setUp` | `FamixUTSuite` | `suite` | `FamixUTSetUp` | |
| `tearDown` | `FamixUTSuite` | `suite` | `FamixUTTearDown` | |
## Properties
======================
| Name | Type | Default value | Comment |
|---|
| `name` | `String` | nil | Basic name of the entity, not full reference.|
"
Class {
#name : #FamixUTSuite,
Expand Down
2 changes: 2 additions & 0 deletions src/Famix-UnitTest-Entities/FamixUTTEntityCreator.trait.st
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
"
This trait is used by Famix models.
It provides an API for creating entities and adding them to the model.
"
Trait {
#name : #FamixUTTEntityCreator,
Expand Down
14 changes: 14 additions & 0 deletions src/Famix-UnitTest-Entities/FamixUTTearDown.class.st
Original file line number Diff line number Diff line change
@@ -1,5 +1,19 @@
"
Tears down the system to make tests repeatable.
## Relations
======================
### Other
| Relation | Origin | Opposite | Type | Comment |
|---|
| `forAllInCase` | `FamixUTTearDown` | `afterAll` | `FamixUTCase` | |
| `forEachInCase` | `FamixUTTearDown` | `afterEach` | `FamixUTCase` | |
| `method` | `FamixUTTearDown` | `tearDown` | `FamixUTMethod` | |
| `suite` | `FamixUTTearDown` | `tearDown` | `FamixUTSuite` | |
"
Class {
#name : #FamixUTTearDown,
Expand Down

0 comments on commit 85123b0

Please sign in to comment.