Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document MqttUtf8String.toString() behavior #523

Open
Marcono1234 opened this issue Jan 11, 2022 · 0 comments
Open

Document MqttUtf8String.toString() behavior #523

Marcono1234 opened this issue Jan 11, 2022 · 0 comments

Comments

@Marcono1234
Copy link

Problem or use case

It appears the intention of MqttUtf8String.toString() is to return the decoded String (see also implementation). However, this is currently not documented; toString() is not overridden and its documentation is not adjusted. It is therefore not obvious how a user can easily get a String from a MqttUtf8String.

Preferred solution or suggestions

If MqttUtf8String.toString() is guaranteed to return the decoded String, then MqttUtf8String should override toString() and add a Javadoc comment to it describing its behavior.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants