Add sound library reference post-processing steps to refBuild script #5
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
SableRaf
added a commit
to processing/processing-website
that referenced
this pull request
Mar 19, 2024
These files were created by running the `processingrefBuild.sh` script as updated by Kevin in processing/processing-doclet#5
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
As discussed in #3, the sound library doclet reference requires some post-processing steps to generate documentation for methods inherited by subclasses. This pull request incorporates an improved version of this post-processing as part of the
processingrefBuild.shscript. The post-processing requires two small and easily available binary dependencies (jqandsponge). Since the original doclet process already required callingnpxfor prettifying the JSON files I have also incorporated the call tonpxin the shell script, added checks and warnings regarding all three dependencies to the script, as well as added a note about them to the README.I expect to make some more small changes to the sound library specific portions over the coming month, so this pull request is really just an invitation for review/comments of whether this could/should be merged at all.
As a side-note: the refbuild script prints "Removing previous version of the ref..." to the shell before building the new javadoc, even though no actual deletion of pre-existing json files in the output directory happens. The sound library reference requires all pre-existing json files to be cleared in order to create valid documentation, so I have had to add a separate
rmcall to clear the sound-specific files.