You are viewing a plain text version of this content. The canonical link for it is here.
Posted to reviews@kudu.apache.org by "Alexey Serbin (Code Review)" <ge...@cloudera.org> on 2018/10/25 01:38:42 UTC

[kudu-CR] [c++ client] clean up inline doxygen documentation

Alexey Serbin has uploaded this change for review. ( http://gerrit.cloudera.org:8080/11780


Change subject: [c++ client] clean up inline doxygen documentation
......................................................................

[c++ client] clean up inline doxygen documentation

This patch cleans up doxygen documentation in client.h.
Most importantly, this patch removes the internal API
methods (i.e. methods marked with KUDU_NO_EXPORT attribute)
from the auto-generated documentation.  Fixed other typos
and mistakes in doxygen formatting, so now doxygen outputs
less warnings.

The rest of the doxygen warnings will be addressed in a follow-up
patch.

Change-Id: Ib0038f45e746896b6abbcfaa5741760218d7a9ad
---
M src/kudu/client/client.h
1 file changed, 55 insertions(+), 23 deletions(-)



  git pull ssh://gerrit.cloudera.org:29418/kudu refs/changes/80/11780/1
-- 
To view, visit http://gerrit.cloudera.org:8080/11780
To unsubscribe, visit http://gerrit.cloudera.org:8080/settings

Gerrit-Project: kudu
Gerrit-Branch: master
Gerrit-MessageType: newchange
Gerrit-Change-Id: Ib0038f45e746896b6abbcfaa5741760218d7a9ad
Gerrit-Change-Number: 11780
Gerrit-PatchSet: 1
Gerrit-Owner: Alexey Serbin <as...@cloudera.com>

[kudu-CR] [c++ client] clean up inline doxygen documentation

Posted by "Adar Dembo (Code Review)" <ge...@cloudera.org>.
Adar Dembo has posted comments on this change. ( http://gerrit.cloudera.org:8080/11780 )

Change subject: [c++ client] clean up inline doxygen documentation
......................................................................


Patch Set 1: Code-Review+2


-- 
To view, visit http://gerrit.cloudera.org:8080/11780
To unsubscribe, visit http://gerrit.cloudera.org:8080/settings

Gerrit-Project: kudu
Gerrit-Branch: master
Gerrit-MessageType: comment
Gerrit-Change-Id: Ib0038f45e746896b6abbcfaa5741760218d7a9ad
Gerrit-Change-Number: 11780
Gerrit-PatchSet: 1
Gerrit-Owner: Alexey Serbin <as...@cloudera.com>
Gerrit-Reviewer: Adar Dembo <ad...@cloudera.com>
Gerrit-Reviewer: Alexey Serbin <as...@cloudera.com>
Gerrit-Reviewer: Attila Bukor <ab...@apache.org>
Gerrit-Reviewer: Hao Hao <ha...@cloudera.com>
Gerrit-Reviewer: Kudu Jenkins (120)
Gerrit-Reviewer: Tidy Bot (241)
Gerrit-Reviewer: Will Berkeley <wd...@gmail.com>
Gerrit-Comment-Date: Thu, 25 Oct 2018 03:38:45 +0000
Gerrit-HasComments: No

[kudu-CR] [c++ client] clean up inline doxygen documentation

Posted by "Alexey Serbin (Code Review)" <ge...@cloudera.org>.
Alexey Serbin has posted comments on this change. ( http://gerrit.cloudera.org:8080/11780 )

Change subject: [c++ client] clean up inline doxygen documentation
......................................................................


Patch Set 1:

(1 comment)

http://gerrit.cloudera.org:8080/#/c/11780/1/src/kudu/client/client.h
File src/kudu/client/client.h:

http://gerrit.cloudera.org:8080/#/c/11780/1/src/kudu/client/client.h@2168
PS1, Line 2168:   static const uint64_t PAD_UNIXTIME_MICROS_TO_16_BYTES = 1 << 0;
> warning: invalid case style for global constant 'PAD_UNIXTIME_MICROS_TO_16_
I'm going to ignore this TidyBot's suggestion since the mentioned constant is a part of the Kudu C++ client public API.



-- 
To view, visit http://gerrit.cloudera.org:8080/11780
To unsubscribe, visit http://gerrit.cloudera.org:8080/settings

Gerrit-Project: kudu
Gerrit-Branch: master
Gerrit-MessageType: comment
Gerrit-Change-Id: Ib0038f45e746896b6abbcfaa5741760218d7a9ad
Gerrit-Change-Number: 11780
Gerrit-PatchSet: 1
Gerrit-Owner: Alexey Serbin <as...@cloudera.com>
Gerrit-Reviewer: Alexey Serbin <as...@cloudera.com>
Gerrit-Reviewer: Attila Bukor <ab...@apache.org>
Gerrit-Reviewer: Hao Hao <ha...@cloudera.com>
Gerrit-Reviewer: Kudu Jenkins (120)
Gerrit-Reviewer: Tidy Bot (241)
Gerrit-Reviewer: Will Berkeley <wd...@gmail.com>
Gerrit-Comment-Date: Thu, 25 Oct 2018 01:47:24 +0000
Gerrit-HasComments: Yes

[kudu-CR] [c++ client] clean up inline doxygen documentation

Posted by "Alexey Serbin (Code Review)" <ge...@cloudera.org>.
Alexey Serbin has submitted this change and it was merged. ( http://gerrit.cloudera.org:8080/11780 )

Change subject: [c++ client] clean up inline doxygen documentation
......................................................................

[c++ client] clean up inline doxygen documentation

This patch cleans up doxygen documentation in client.h.
Most importantly, this patch removes the internal API
methods (i.e. methods marked with KUDU_NO_EXPORT attribute)
from the auto-generated documentation.  Fixed other typos
and mistakes in doxygen formatting, so now doxygen outputs
less warnings.

The rest of the doxygen warnings will be addressed in a follow-up
patch.

Change-Id: Ib0038f45e746896b6abbcfaa5741760218d7a9ad
Reviewed-on: http://gerrit.cloudera.org:8080/11780
Tested-by: Kudu Jenkins
Reviewed-by: Adar Dembo <ad...@cloudera.com>
---
M src/kudu/client/client.h
1 file changed, 55 insertions(+), 23 deletions(-)

Approvals:
  Kudu Jenkins: Verified
  Adar Dembo: Looks good to me, approved

-- 
To view, visit http://gerrit.cloudera.org:8080/11780
To unsubscribe, visit http://gerrit.cloudera.org:8080/settings

Gerrit-Project: kudu
Gerrit-Branch: master
Gerrit-MessageType: merged
Gerrit-Change-Id: Ib0038f45e746896b6abbcfaa5741760218d7a9ad
Gerrit-Change-Number: 11780
Gerrit-PatchSet: 2
Gerrit-Owner: Alexey Serbin <as...@cloudera.com>
Gerrit-Reviewer: Adar Dembo <ad...@cloudera.com>
Gerrit-Reviewer: Alexey Serbin <as...@cloudera.com>
Gerrit-Reviewer: Attila Bukor <ab...@apache.org>
Gerrit-Reviewer: Hao Hao <ha...@cloudera.com>
Gerrit-Reviewer: Kudu Jenkins (120)
Gerrit-Reviewer: Tidy Bot (241)
Gerrit-Reviewer: Will Berkeley <wd...@gmail.com>