Skip to content

Commit e3ead96

Browse files
committed
fixed javadoc display errors
- escaped special characters for html - warnings are still in place
1 parent e4aeb2a commit e3ead96

6 files changed

Lines changed: 38 additions & 41 deletions

File tree

src/main/java/gprover/GDD.java

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
public class GDD extends GDDBase {
2020

2121
/**
22-
* Performs the fixedpoint computation for the geometric deduction system.
22+
* Performs the fixed point computation for the geometric deduction system.
2323
* Processes all pending conditions, adjusts parameters, and collects results.
2424
*/
2525
void fixpoint() {
@@ -760,7 +760,7 @@ final void search_cr_md(ACir cr) {
760760
}
761761

762762
/**
763-
* Searches for additional circleline intersections within a PLine.
763+
* Searches for additional circle line intersections within a PLine.
764764
*
765765
* @param cr1 the circle to search intersections with
766766
* @param p1 the first point index defining the line
@@ -832,7 +832,7 @@ final void search_cr_tan(ACir cr1, TLine tn) {
832832
}
833833

834834
/**
835-
* Searches for circlecircle intersections between the provided circle and all other circles.
835+
* Searches for circle circle intersections between the provided circle and all other circles.
836836
*
837837
* @param cr1 the circle to search for intersections with other circles
838838
*/
@@ -890,7 +890,7 @@ final void search_cr_iso(ACir cr1, int p1, int p2) {
890890
}
891891

892892
/**
893-
* Searches and constructs midpointrelated cyclic configurations for the given circle.
893+
* Searches and constructs midpoint related cyclic configurations for the given circle.
894894
*
895895
* @param cr the circle to process
896896
* @param md the midpoint data structure containing endpoints and the midpoint
@@ -936,7 +936,7 @@ final void search_cr_cg(ACir cr1) {
936936

937937

938938
/**
939-
* Processes all midpointrelated configurations including congruence, parallel, and cyclic conditions.
939+
* Processes all midpoint related configurations including congruence, parallel, and cyclic conditions.
940940
*
941941
* @param md the midpoint to process
942942
*/

src/main/java/gprover/GTerm.java

Lines changed: 26 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -8,18 +8,18 @@
88
* JGEX supports loading and saving scripts in a simple textual format.
99
* Among the examples, these files have no extension (see, e.g. 3_JAR/simson).
1010
* This class can load and save them.
11-
* * Represents geometric constructions and their associated operations.
12-
* *
13-
* * <p>This class encapsulates the management of points, construction steps,
14-
* * and constraints within a geometric theorem proving framework.
15-
* * It provides methods for adding, retrieving, and processing geometric data,
16-
* * including the generation of non-degenerate and prerequisite constraints.
17-
* * Fundamental operations include loading, saving, and validating the structure
18-
* * of geometric constructions.</p>
19-
* *
20-
* * <p>Utilize this class to perform geometric analyses and manipulations necessary
21-
* * for automated theorem proving and geometric constraint solving within the
22-
* * framework.</p>
11+
* * Represents geometric constructions and their associated operations.
12+
* *
13+
* * <p>This class encapsulates the management of points, construction steps,
14+
* * and constraints within a geometric theorem proving framework.
15+
* * It provides methods for adding, retrieving, and processing geometric data,
16+
* * including the generation of non-degenerate and prerequisite constraints.
17+
* * Fundamental operations include loading, saving, and validating the structure
18+
* * of geometric constructions.</p>
19+
* *
20+
* * <p>Utilize this class to perform geometric analyses and manipulations necessary
21+
* * for automated theorem proving and geometric constraint solving within the
22+
* * framework.</p>
2323
*/
2424
public class GTerm {
2525

@@ -61,9 +61,9 @@ public Cons getCons(int n) {
6161
}
6262

6363
/**
64-
* Returns a vector containing nondegenerate constraints.
64+
* Returns a vector containing non degenerate constraints.
6565
*
66-
* @return a vector of CNdg objects representing nondegenerate constraints
66+
* @return a vector of CNdg objects representing non degenerate constraints
6767
*/
6868
public Vector getNcons() {
6969
Vector v = new Vector();
@@ -89,7 +89,7 @@ else if (c.type == Gib.CO_PERP)
8989
/**
9090
* Generates a string description for the specified CNdg object based on the provided parameters.
9191
*
92-
* @param dg the CNdg object to update with its description
92+
* @param dg the CNdg object to update with its description
9393
* @param pss the array of parameters used for generating the description
9494
*/
9595
public void generateSd(CNdg dg, Object[] pss) {
@@ -434,8 +434,8 @@ public boolean add_pt(String s) {
434434
* Sets the location for the point matching the given name.
435435
*
436436
* @param sn the name of the point
437-
* @param x the x-coordinate of the point
438-
* @param y the y-coordinate of the point
437+
* @param x the x-coordinate of the point
438+
* @param y the y-coordinate of the point
439439
* @param x1 the first additional coordinate parameter
440440
* @param y1 the second additional coordinate parameter
441441
* @return true if the point location is successfully set; false otherwise
@@ -698,6 +698,7 @@ public boolean isPositionSet() {
698698

699699
/**
700700
* Add a conclusion to the construction.
701+
*
701702
* @param ln A script command in the form "SHOW: COLLINEAR P Q R"
702703
* @return if the conclusion was added successfully
703704
*/
@@ -904,7 +905,7 @@ public void addInterSS(String[] list) {
904905
* Adds a constant to the construction.
905906
* Creates a new constant constraint using the provided identifier and function.
906907
*
907-
* @param sf the identifier for the constant.
908+
* @param sf the identifier for the constant.
908909
* @param func the function defining the constant.
909910
*/
910911
public void addConstant(String sf, String func) {
@@ -1334,7 +1335,7 @@ public void setConclusionNo() {
13341335
/**
13351336
* Checks if a valid conclusion exists in the construction.
13361337
*
1337-
* @return true if the last condition type is within the valid range (>= 50 and < 100); false otherwise.
1338+
* @return true if the last condition type is within the valid range (&gt;= 50 and &lt; 100); false otherwise.
13381339
*/
13391340
public boolean hasConclusion() {
13401341
int n = gcons.size();
@@ -1476,8 +1477,7 @@ public void getAllCircles() {
14761477
addccc(c2.ps[2], c2.ps[3], c1);
14771478
v.remove(j);
14781479
r = true;
1479-
} else
1480-
if (c1.ps[k * 2] == c2.ps[2] && c1.ps[k * 2 + 1] == c2.ps[3] || c1.ps[k * 2] == c2.ps[3] && c1.ps[k * 2 + 1] == c2.ps[2]) {
1480+
} else if (c1.ps[k * 2] == c2.ps[2] && c1.ps[k * 2 + 1] == c2.ps[3] || c1.ps[k * 2] == c2.ps[3] && c1.ps[k * 2 + 1] == c2.ps[2]) {
14811481
addccc(c2.ps[0], c2.ps[1], c1);
14821482
v.remove(j);
14831483
r = true;
@@ -1527,8 +1527,8 @@ else if (c.ps[k * 2 + 1] == c.ps[j])
15271527
* Adds a circle constraint between the two specified points to the provided constraint,
15281528
* if the connection does not already exist.
15291529
*
1530-
* @param a the first point index.
1531-
* @param b the second point index.
1530+
* @param a the first point index.
1531+
* @param b the second point index.
15321532
* @param cs the constraint to which the circle condition is added.
15331533
*/
15341534
public void addccc(int a, int b, Cons cs) {
@@ -1638,7 +1638,7 @@ public void add_eqcons(int a, int b, int c, int d) {
16381638
* Retrieves and removes the first constraint in the vector that contains the specified point.
16391639
*
16401640
* @param pt the point identifier to search for in the constraints.
1641-
* @param v the vector of constraints to search through.
1641+
* @param v the vector of constraints to search through.
16421642
* @return the constraint that contains the point, or null if no such constraint exists.
16431643
*/
16441644
public Cons getcons(int pt, Vector v) {
@@ -1815,9 +1815,7 @@ public void generateCons(Cons c, Vector v) {
18151815
case Gib.C_TRAPEZOID:
18161816
case Gib.C_R_TRAPEZOID:
18171817
case Gib.C_LOZENGE:
1818-
case Gib.C_RECTANGLE:
1819-
1820-
{
1818+
case Gib.C_RECTANGLE: {
18211819
Cons c1 = this.getNDG_COLL(c.ps[0], c.ps[1], c.ps[2], c.pss[0], c.pss[1], c.pss[2]);
18221820
addNDG(c1, v);
18231821
break;
@@ -2093,7 +2091,7 @@ public void addNDG(Cons c, Vector v) {
20932091
/**
20942092
* Checks if the first non-degenerate constraint is considered contained within the second.
20952093
*
2096-
* @param c the constraint to check for containment.
2094+
* @param c the constraint to check for containment.
20972095
* @param c1 the constraint that may contain the first.
20982096
* @return true if the first constraint is contained within the second, false otherwise.
20992097
*/

src/main/java/pdf/BoundingBox.java

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,10 @@
2525
import java.awt.*;
2626
import java.util.*;
2727

28+
/**
29+
* This class represents a bounding box.
30+
* It holds coordinate information and properties used for graphical operations.
31+
*/
2832
public class BoundingBox extends Rectangle
2933
{
3034
/** Percent f line height to space lines */

src/main/java/wprover/CPoint.java

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -199,11 +199,6 @@ public void draw(Graphics2D g2, boolean selected) {
199199
g2.drawOval(x - radius, y - radius, 2 * radius, 2 * radius);
200200
}
201201

202-
/**
203-
* Gets the default radius of the point.
204-
*
205-
* @return the default radius of the point
206-
*/
207202
public int POINT_RADIUS = CMisc.getPointRadius();
208203

209204
/**

src/main/java/wprover/CProveText.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -918,7 +918,7 @@ public void saveText(DataOutputStream out, int space) throws IOException {
918918
* Saves the proof text as a PostScript file.
919919
*
920920
* @param fp the file output stream to write to
921-
* @param stype the style type (0 for color, 1 for gray, 2 for black & white)
921+
* @param stype the style type (0 for color, 1 for gray, 2 for black &amp; white)
922922
* @param ntype the number type (0 for default, 1 for 20 added, 2 for 25 added)
923923
* @throws IOException if an I/O error occurs
924924
*/
@@ -963,7 +963,7 @@ else if (ntype == 2)
963963
*
964964
* @param c the color to set
965965
* @param fp the file output stream to write to
966-
* @param stype the style type (0 for color, 1 for gray, 2 for black & white)
966+
* @param stype the style type (0 for color, 1 for gray, 2 for black &amp; white)
967967
* @throws IOException if an I/O error occurs
968968
*/
969969
public void SavePsColor(Color c, FileOutputStream fp, int stype) throws IOException {

src/main/java/wprover/CText.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -703,7 +703,7 @@ else if (type == NAME_TEXT) {
703703
* Saves the text object as a PostScript file.
704704
*
705705
* @param fp the file output stream to write to
706-
* @param stype the style type (0 for color, 1 for gray, 2 for black & white)
706+
* @param stype the style type (0 for color, 1 for gray, 2 for black &amp; white)
707707
* @throws IOException if an I/O error occurs
708708
*/
709709
public void SavePS(FileOutputStream fp, int stype) throws IOException {

0 commit comments

Comments
 (0)