Smarthome: Static Code Analysis Tool reports unaddressed TODO comments in SoftwareUpdate

[kssimova]

I'm currently fixing issues in Smarthome, found by the Static Code Analysis Tool. The included check from Checkstyle - TodoCommentCheck, which checks for left // todo comments in javadoc, reports SoftwareUpdate and I can not find an open issue with discussion or the documentation about it.

Comment had been introduced with this commit.

@maggu2810 Аs an author, do you think that this is still an issue or we can remove the TODO comment?

[maggu2810]

Comment had been introduced with this commit.

Please have a look at the commit. It's message is "run Eclipse formatter rules on Hue binding (#3123)" and should also apply formatter changes. I am not the author of that TODO.

[kssimova]

Yes, I'm very sorry about that! It seems that it has been taken from https://github.com/Q42/Jue and it is still undocumented. Should I remove the TODO comment then?

[maggu2810]

No problem at all :wink:

We could perhaps change it to:

    /**
     * Returns the state of the update.
     *
     * <p>
     * Actual meaning currently undocumented
     *
     * @return state of update
     */

as there is nothing to do if it is not documented.

[maggu2810]

Hi @kssimova,
thank you for fixing that issue yourself.

FYI if your PR or a commit message (I would prefer the commit message, as it is part of the Git log then) contains special keywords, the referenced issue will be closed automatically if the PR has been merged.

You can have a look at the documentation here: https://help.github.com/articles/closing-issues-using-keywords/

[kssimova]

@maggu2810 Thank you! I will take a look at it. :)