{"id":26716425,"url":"https://github.com/processing/processing-doclet","last_synced_at":"2025-04-14T01:25:30.606Z","repository":{"id":66188726,"uuid":"382627177","full_name":"processing/processing-doclet","owner":"processing","description":null,"archived":false,"fork":false,"pushed_at":"2024-08-12T09:11:56.000Z","size":5414,"stargazers_count":1,"open_issues_count":4,"forks_count":6,"subscribers_count":12,"default_branch":"main","last_synced_at":"2025-03-27T15:31:02.656Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/processing.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2021-07-03T13:51:34.000Z","updated_at":"2024-07-18T11:24:01.000Z","dependencies_parsed_at":null,"dependency_job_id":"d4c1204f-d233-4c31-a270-02eac3c59539","html_url":"https://github.com/processing/processing-doclet","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/processing%2Fprocessing-doclet","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/processing%2Fprocessing-doclet/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/processing%2Fprocessing-doclet/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/processing%2Fprocessing-doclet/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/processing","download_url":"https://codeload.github.com/processing/processing-doclet/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248805845,"owners_count":21164400,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-03-27T15:27:08.832Z","updated_at":"2025-04-14T01:25:30.562Z","avatar_url":"https://github.com/processing.png","language":"Java","readme":"# Doclet\n\nThis is a custom Doclet that generates JSON files based on Javadoc comments in `.java` files. These JSON files have all the information necessary for building the reference pages on [processing.org](https://processing.org).\n\nThe Doclet will run through the `.java` file in the following repositories:\n\n- [`processing/processing4`](https://github.com/processing/processing4)\n- [`processing/processing-sound`](https://github.com/processing/processing-sound)\n- [`processing/processing-video`](https://github.com/processing/processing-video)\n\nIt will read the JavaDoc comments, create a series of `.json` files, and save them into the Processing website repository in the `content/references/translations/en/` folder:\n\n- [`processing/processing-website`](https://github.com/processing/processing-website)\n\nYou will need a local copy of at least one of `processing/processing4`, `processing/processing-sound` or `processing/processing-video` alongside the `processing/processing-website` repo. The repositories need to be alongside each other in the same folder.\n\n## How to use\n\nFirst, make sure that you have the proper setup before running the script:\n\n### Get set up\n\n1. If this is your first time, clone fresh versions of the following repositories alongside each other in the same folder:\n   - [`processing/processing4`](https://github.com/processing/processing4)\n   - [`processing/processing-sound`](https://github.com/processing/processing-sound)\n   - [`processing/processing-video`](https://github.com/processing/processing-video)\n   - [`processing/processing-website`](https://github.com/processing/processing-website)\n   \nIf you already have those repositories cloned locally, just make sure that the latest commit of the `main` branch is checked out on all of them.\n\n2. Make sure you have openjdk 17 installed and set the `JAVA_HOME` environment variable to point to the JDK installation. For example: `/Users/yourName/Library/Java/JavaVirtualMachines/corretto-17.0.4.1/Contents/Home`\n\nRunning `java -version` should return the following:\n\n```\nopenjdk version \"17.0.4.1\" 2022-08-12 LTS\nOpenJDK Runtime Environment Corretto-17.0.4.9.1 (build 17.0.4.1+9-LTS)\nOpenJDK 64-Bit Server VM Corretto-17.0.4.9.1 (build 17.0.4.1+9-LTS, mixed mode, sharing)\n```\n\n_Note that the name of the JDK file may vary slightly depending on your exact version._\n\n3. Install the latest version of [Apache Ant](https://ant.apache.org/manual/install.html) (1.10.13 or above).\n\n4. Build the code for [`processing/processing4`](https://github.com/processing/processing4) and [`processing/processing-sound`](https://github.com/processing/processing-sound) by following the instructions on their respective repositories and running the necessary Ant commands.\n\n### Run the doclet script\n\nNow you are ready to run the doclet:\n\n1. `cd` into the `processing-doclet/ReferenceGenerator` folder.\n2. Run `ant compile`.\n3. Run `./processingrefBuild.sh` if you are updating all the repositories or `./processingrefBuild.sh processing`, `./processingrefBuild.sh sound` or `./processingrefBuild.sh video` if you are updating a single repository.\n4. After the new JSON files are created, move into `processing-website` and run `npx prettier --write content/references` to format the JSON files.\n\n### Update the website\n\nFollow the instructions over on the [`processing/processing-website`](https://github.com/processing/processing-website) repository to make a pull request for the newly updated reference files.\n\n## Testing the script\nIf you just want to test the Doclet without the `processing-website` repo, you can create the following folder structure in the root folder\n\n`processing-website/content/references/translations/en/`\n\nThen run the doclet script normally and it will generate the JSON files in the folder above.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprocessing%2Fprocessing-doclet","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fprocessing%2Fprocessing-doclet","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprocessing%2Fprocessing-doclet/lists"}