Skip to content

Commit 4254cdd

Browse files
peterbacklundpeterbacklund
committed
Added missing package descriptions and corrected a few of the existing ones.
1 parent 02511b2 commit 4254cdd

File tree

12 files changed

+62
-13
lines changed

12 files changed

+62
-13
lines changed

‎dddsample/src/main/java/se/citerus/dddsample/application/impl/package.html

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
11
<html>
22
<body>
33
<p>
4-
The routing service interface, which is part of the domain layer, is implemented by translating
5-
our model and delegating work to a remote service in a different context. The recieved routing data
6-
is also translated back to our model, forming a cargo itinerary.
4+
Implementation of the application layer.
75
</p>
86
</body>
97
</html>

‎dddsample/src/main/java/se/citerus/dddsample/application/package.html

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,16 @@
11
<html>
22
<body>
33
<p>
4-
This is the application layer: code that's needed for the application to
5-
performs its tasks. This includes code that directly depends on external libraries
6-
such as Hibernate and Spring MVC, implementations of JMS interfaces, remoting and so on.
4+
This is the application layer: code that's needed for the application to
5+
performs its tasks. It defines, or is defined by, use cases.
76
</p>
87
<p>
9-
This part is very technology-heavy and generally not comprehensible to the domain expert,
10-
unlike the domain part. It is thin in terms of knowledge of domain business logic,
11-
although it may be large in terms of lines of code.
8+
It is thin in terms of knowledge of domain business logic,
9+
although it may be large in terms of lines of code.
10+
It coordinates the domain layer objects to perform the actual tasks.
11+
</p>
12+
<p>
13+
This layer is suitable for spanning transactions, security checks and high-level logging.
1214
</p>
1315
</body>
1416
</html>

‎dddsample/src/main/java/se/citerus/dddsample/domain/model/voyage/package.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<html>
22
<body>
33
<p>
4-
The carrier aggregate. CarrierMovement is the aggregate root.
4+
The voyage aggregate. Voyage is the aggregate root.
55
</p>
66
</body>
77
</html>

‎dddsample/src/main/java/se/citerus/dddsample/domain/shared/experimental/package.html

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
<html>
2+
<body>
3+
<p>
4+
Experimental versions of pattern interfaces and support code for the domain layer.
5+
Not used in the application.
6+
</p>
7+
</body>
8+
</html>

‎dddsample/src/main/java/se/citerus/dddsample/domain/shared/package.html

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
<html>
2+
<body>
3+
<p>
4+
Pattern interfaces and support code for the domain layer.
5+
</p>
6+
</body>
7+
</html>

‎dddsample/src/main/java/se/citerus/dddsample/infrastructure/routing/package.html

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
<html>
2+
<body>
3+
<p>
4+
Communicates with the Pathfinder external routing service.
5+
</p>
6+
</body>
7+
</html>

‎dddsample/src/main/java/se/citerus/dddsample/interfaces/booking/facade/internal/package.html

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
<html>
2+
<body>
3+
<p>
4+
Internal parts of the remote facade API.
5+
</p>
6+
</body>
7+
</html>

‎dddsample/src/main/java/se/citerus/dddsample/interfaces/booking/web/package.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<html>
22
<body>
33
<p>
4-
Web user interfaces for tracking and booking cargo. Uses Spring MVC.
4+
Web user interfaces for booking, routing and re-routing cargo.
55
</p>
66
</body>
77
</html>

‎dddsample/src/main/java/se/citerus/dddsample/interfaces/handling/file/package.html

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
<html>
2+
<body>
3+
<p>
4+
Handles event registration by file upload.
5+
</p>
6+
</body>
7+
</html>

‎dddsample/src/main/java/se/citerus/dddsample/interfaces/handling/package.html

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
<html>
22
<body>
33
<p>
4-
The web service interface for registering handling events, implemented using JAX-WS.
5-
This is an Open Host Service with data model translation and basic validation, and part of the infrastructure.
4+
Interfaces for receiving handling events into the system.
65
</p>
76
</body>
87
</html>

0 commit comments

Comments
 (0)