MCP Testing — Javadocs

Status

Checking for generated Javadocs...

Generate Javadocs locally

Run these commands from the repository root (C:\Users\abhir\Downloads\my_projects\mcpTesting) on a machine with Maven and a JDK installed. After generation, copy the produced apidocs into this folder (docs/javadoc/apidocs) so GitHub Pages will serve them.

mvn -DskipTests javadoc:aggregate
# copy generated apidocs into the docs folder so GitHub Pages will serve them
# (PowerShell)
Copy-Item -Path .\target\site\apidocs\* -Destination .\docs\javadoc\apidocs -Recurse -Force

# (or using git & CI) run the build in CI and commit the generated apidocs into docs/javadoc/apidocs
          

Need help?

• If you'd like, I can provide a small PowerShell script to simplify the local generation and copy steps.
• I can also help add a GitHub Actions workflow that generates the javadocs and commits the built files into the branch automatically (recommended for reproducibility).

Scripts (one-shot)

Convenience scripts are included in the repository under docs/scripts/. Use them to generate and copy the aggregated Javadocs into docs/javadoc/apidocs.

• PowerShell (Windows): docs\scripts\generate_javadocs.ps1
• POSIX shell (macOS / Linux / WSL / Git Bash): docs/scripts/generate_javadocs.sh

# Run PowerShell (from repo root)
PowerShell -ExecutionPolicy Bypass -File .\docs\scripts\generate_javadocs.ps1

# Run POSIX shell
sh docs/scripts/generate_javadocs.sh

# (Optional) Make the shell script executable in the git repository so Unix checkouts preserve the bit:
git add docs/scripts/generate_javadocs.sh
git update-index --chmod=+x docs/scripts/generate_javadocs.sh
git commit -m "chore(docs): add javadoc generation scripts (make sh executable)"