Skip to content

Commit 604e9ca

Browse files
committed
added javadoc for packages
1 parent 8ad3530 commit 604e9ca

5 files changed

Lines changed: 31 additions & 0 deletions

File tree

src/main/java/UI/package-info.java

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
/**
2+
* This package handles the presentation layer of the application by managing UI components
3+
* and event handling. It includes classes for creating and managing the graphical user interface.
4+
*/
5+
package UI;
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
/**
2+
* The gprover package contains the core classes and interfaces related to the
3+
* gprover project. This package serves as the central point
4+
* for the implementation of the proof algorithms and related utilities.
5+
*/
6+
package gprover;
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
/**
2+
* This package provides functionalities for mathematical operations.
3+
* It serves as a foundation for further mathematical computations in the project.
4+
*/
5+
package maths;
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
/**
2+
* This package serves as the foundation for managing, processing, and generating PDF documents
3+
* within the project.
4+
*/
5+
package pdf;
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
/**
2+
* The wprover package provides core functionalities for geometric proving and constraint-based computations.
3+
* This package is designed with a clear separation of concerns. It encapsulates the core proving logic,
4+
* geometric drawing operations, and constraint verifications while isolating these functionalities from the
5+
* main user interface management. Classes such as DrawBase demonstrate this design by offering methods for
6+
* drawing geometric elements and handling interactions.
7+
* Note: Although the focus of this package is on the prover functionalities, some classes may include minimal
8+
* UI components solely to support interactive functionalities within the proving process.
9+
*/
10+
package wprover;

0 commit comments

Comments
 (0)