Skip to content

Add API Javadocs for ClipperBase, Clipper64, and ClipperD#37

Merged
micycle1 merged 2 commits intomasterfrom
copilot/add-javadocs-to-clipper-methods
Mar 9, 2026
Merged

Add API Javadocs for ClipperBase, Clipper64, and ClipperD#37
micycle1 merged 2 commits intomasterfrom
copilot/add-javadocs-to-clipper-methods

Conversation

Copy link
Contributor

Copilot AI commented Mar 9, 2026

This updates the public-facing clipping APIs to add missing Javadocs across ClipperBase, Clipper64, and ClipperD. The goal is to make the core entry points and result-building methods self-describing in generated API docs without changing runtime behavior.

  • ClipperBase API coverage

    • Documented core configuration and lifecycle methods such as:
      • getPreserveCollinear()
      • getReverseSolution()
      • setReverseSolution(...)
      • clear()
      • getBounds()
    • Added Javadocs for path-loading methods and reusable-data entry points:
      • addSubject(...)
      • addOpenSubject(...)
      • addClip(...)
      • addPath(...)
      • addPaths(...)
      • addReuseableData(...)
    • Documented solution-construction helpers used by subclasses:
      • ExecuteInternal(...)
      • buildPath(...)
      • BuildPaths(...)
      • BuildTree(...)
  • Clipper64 execute overloads

    • Added Javadocs for the public execute(...) overloads returning:
      • Paths64
      • PolyTree64
    • Documented the reusable-data override so the long-coordinate API is fully covered in generated docs.
  • ClipperD double-coordinate API

    • Documented constructors, including precision behavior for internal scaling.
    • Added Javadocs for all public path-loading helpers:
      • addPath(...)
      • addPaths(...)
      • addSubject(...)
      • addOpenSubject(...)
      • addClip(...)
      • plural variants for each
    • Added Javadocs for all execute(...) overloads returning:
      • PathsD
      • PolyTreeD
  • Example

    • The updated docs now describe usage directly at the API boundary, e.g.:
ClipperD clipper = new ClipperD(3);
clipper.addSubject(subjectPaths);
clipper.addClips(clipPaths);

PathsD closed = new PathsD();
PathsD open = new PathsD();
clipper.execute(ClipType.Union, FillRule.NonZero, closed, open);

💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Co-authored-by: micycle1 <9304234+micycle1@users.noreply.github.com>
@micycle1 micycle1 marked this pull request as ready for review March 9, 2026 13:48
Copilot AI changed the title [WIP] Add Javadocs to public facing methods in Clipper classes Add API Javadocs for ClipperBase, Clipper64, and ClipperD Mar 9, 2026
@micycle1 micycle1 merged commit 290517c into master Mar 9, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants