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

Tidy up code and javadoc #104

Merged
merged 5 commits into from
Sep 3, 2021
Merged

Tidy up code and javadoc #104

merged 5 commits into from
Sep 3, 2021

Conversation

Noordfrees
Copy link
Member

@Noordfrees Noordfrees commented Sep 1, 2021

Re #97

@Noordfrees Noordfrees added documentation Improvements or additions to documentation enhancement New feature or request maintenance Shell scripts & backend stuff labels Sep 1, 2021
@Noordfrees Noordfrees self-assigned this Sep 1, 2021
Comment on lines 64 to 68
* If the password is correct, the server replies not <code>ADMIN</code>/<code>SUCCESS</code> but
* instead prints out server statistics in the following format: <ul> <li> Time in [1: milliseconds
* | 2+: hours] since the server was started, <code>\n</code> <li> {@literal Protocol version >= 2}:
* Average client lifetime in seconds, <code>\n</code> <li> Protocol version 1: <ul><li> Number of
* current registered users, <code>\n</code> <li> Number of current unregistered users,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hm, stupid clang-format...
Is there a way to disable formatting of doc comments?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ouch!
There seems to be no standard way to skip javadoc comments so I disabled clang-format for the whole file. The rest of the documentation should be fine I hope…

@Noordfrees Noordfrees merged commit 1d70d2f into widelands:master Sep 3, 2021
@Noordfrees Noordfrees deleted the javadoc branch September 3, 2021 17:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request maintenance Shell scripts & backend stuff
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants