Collection of RPC device documentation changes #243
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.
Disclaimer: I have no experience with java, nor have these changes been built and tested locally. So please validate them on your side (I'd be happy to do this myself, but don't know how).
Commits:
Added parameter names to RPC device handlers where missing, Deleted missing parameter name handling in scripts/lib/*/devices.*
I believe I have checked the documentation for all of the RPC devices.
Here is the list of (all?) the RPC device typeNames that I have checked;
"robot"
,"inventory_operations"
,"block_operations"
,"redstone"
,"item_handler"
,"oc2:computer"
,"energy_storage"
,"file_import_export"
,"sound"
The
"item_handler"
device is the only one without named parameters. This commit provides the parameter names and thus negates the requirement for handling un-named parameters inscripts/lib/*/devices.*
.This script will print the documentation for an available device's methods (split at the 80th character):
Output:
Attempted to provide device documentation for BlockOperationsModuleDevice
I have attempted to provide
getDeviceDocumentation
forBlockOperationsModuleDevice.java
following the format ofRedstoneInterfaceCardItemDevice.java
with the documentation inblock_operations_module.md
.I would be happy to do the same for all of the remaining devices without
getDeviceDocumentation
. Please let me know if you would like me to do this, and of course, any and all feedback is appreciated.Given my disclaimer above there's a decent chance I've not done this right. Also, I had to take a guess at the prefferred max line-width.