Alexey Serbin has posted comments on this change.
Change subject: doxygen for C++ client API
Patch Set 9:
> One thing we should add to this (it can be a follow-up commit).
> It needs to be integrated into make_site.sh and the web site
Yes, certainly -- I will add that integration is a follow-up commit.
> High level formatting questions:
1. It's a purely stylistic change, it's not related to doxygen requirements at
all. So, if there is some sort of implicit rule of using just one space before
starting a new sentence, I'll revert it back.
2. The idea was to have a brief (i.e. one sentence) a method/class summary, so
no period would be needed since after @brief message there should be an empty
line. However, for parameters and return values there is no guarantee the
description is brief, because it's the only description around for those. So,
@brief would not be ended with a period, but @return and @param would. If that
seems to be an inconsistency, let's end @brief message with a period as well.
3. It's because some methods were treated correspondingly after I got feedback
from Todd in the kudu-dev mailing list :) I.e., I removed @brief comments
which were almost one-to-one copy of the @return comments. I'll take care of
the rest of those simple getters leaving only @return comment.
To view, visit http://gerrit.cloudera.org:8080/3619
To unsubscribe, visit http://gerrit.cloudera.org:8080/settings
Gerrit-Owner: Alexey Serbin <aser...@cloudera.com>
Gerrit-Reviewer: Adar Dembo <a...@cloudera.com>
Gerrit-Reviewer: Alexey Serbin <aser...@cloudera.com>
Gerrit-Reviewer: Dan Burkert <d...@cloudera.com>
Gerrit-Reviewer: Dinesh Bhat <din...@cloudera.com>
Gerrit-Reviewer: Kudu Jenkins
Gerrit-Reviewer: Mike Percy <mpe...@apache.org>
Gerrit-Reviewer: Misty Stanley-Jones <mi...@apache.org>