Add mqtt documentation generator resource - #1011
Draft
andreniggemann wants to merge 1 commit into
Draft
Conversation
It's designed to automatically generate up to date documentation from the Topics connected to an MQTT Driver. It has some known limitiations: a) It has no localization support, but I think thats ok for an engineering focused tool. b) It only supports MqttJsonTopics natively. It would be nice to find a way to support our other topic types or even user defined topic types
This file contains hidden or 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
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.
Summary
It's designed to automatically generate up to date documentation from the Topics connected to an MQTT Driver.
It has some known limitiations:
a) It has no localization support, but I think thats ok for an engineering focused tool.
b) It only supports MqttJsonTopics natively. It would be nice to find a way to support our other topic types or even user defined topic types
Linked Issues
Relevant logs and/or screenshots
Breaking Changes
Checklist for Submitter
Review
Typical tasks
Obsoleteattributes if necessaryClean code