Skip to content

Add mqtt documentation generator resource - #1011

Draft
andreniggemann wants to merge 1 commit into
devfrom
feature/mqtt-documentation-generator
Draft

Add mqtt documentation generator resource#1011
andreniggemann wants to merge 1 commit into
devfrom
feature/mqtt-documentation-generator

Conversation

@andreniggemann

Copy link
Copy Markdown
Collaborator

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

image

Breaking Changes

Checklist for Submitter

  • I have tested these changes locally
  • I have updated documentation as needed
  • I have added or updated tests as appropriate
  • I have used clear and descriptive commit messages

Review

Typical tasks

  • Merge request is well described
  • Added Obsolete attributes if necessary
  • Critical sections are documented in code
  • Tests available or extended
  • Documentation is created / updated
  • Running in test environment
  • Manual is created / updated
  • Ports to other maintained versions are created

Clean code

  • All unused references are removed
  • Clean code rules are respected with passion (naming, ...)
  • Avoid copy and pasted code snippets

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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant