Fix broken 'Related' links in the Network and Serial library web reference #778
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
reference. Known issue: the link to serialEvent_.html is still broken because the target documentation is actually created at Serial_serialEvent_.html based on an internal library function that calls the user-defined `serialEvent()` function that the documentation is actually for. Either this file needs to be moved after generation, or alternatively the documentation could be moved from the Javadoc to a static JSON file (this is also how it is done for the Network library callback)
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.
Location of currently broken links (bottom of the page):
Known issue: the link to
serialEvent_.htmlis still broken because the doclet actually creates the documentation atSerial_serialEvent_.htmlbased on an internal library function that calls the user-definedserialEvent()function that the documentation is actually for. Either this file needs to be moved after generation (by the doclet script), or alternatively the documentation could be moved from the Javadoc to a static JSON file (this is also how it is done for the Network library callback).Also lets processing/processing-doclet/pull/6 choose an appropriate @instanceName (which closes processing/processing-website/issues/397)