{"action":"created","issue":{"url":"https://api.github.com/repos/grpc/grpc/issues/10992","repository_url":"https://api.github.com/repos/grpc/grpc","labels_url":"https://api.github.com/repos/grpc/grpc/issues/10992/labels{/name}","comments_url":"https://api.github.com/repos/grpc/grpc/issues/10992/comments","events_url":"https://api.github.com/repos/grpc/grpc/issues/10992/events","html_url":"https://github.com/grpc/grpc/pull/10992","id":226376335,"number":10992,"title":"Doxygen cpp nits","user":{"login":"apolcyn","id":9566254,"avatar_url":"https://avatars2.githubusercontent.com/u/9566254?v=3","gravatar_id":"","url":"https://api.github.com/users/apolcyn","html_url":"https://github.com/apolcyn","followers_url":"https://api.github.com/users/apolcyn/followers","following_url":"https://api.github.com/users/apolcyn/following{/other_user}","gists_url":"https://api.github.com/users/apolcyn/gists{/gist_id}","starred_url":"https://api.github.com/users/apolcyn/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/apolcyn/subscriptions","organizations_url":"https://api.github.com/users/apolcyn/orgs","repos_url":"https://api.github.com/users/apolcyn/repos","events_url":"https://api.github.com/users/apolcyn/events{/privacy}","received_events_url":"https://api.github.com/users/apolcyn/received_events","type":"User","site_admin":false},"labels":[{"id":170781264,"url":"https://api.github.com/repos/grpc/grpc/labels/cla:%20yes","name":"cla: yes","color":"009800","default":false}],"state":"open","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":11,"created_at":"2017-05-04T18:57:10Z","updated_at":"2017-05-11T17:29:08Z","closed_at":null,"pull_request":{"url":"https://api.github.com/repos/grpc/grpc/pulls/10992","html_url":"https://github.com/grpc/grpc/pull/10992","diff_url":"https://github.com/grpc/grpc/pull/10992.diff","patch_url":"https://github.com/grpc/grpc/pull/10992.patch"},"body":"fixes some doxygen-unrecognized comments so far.\r\n\r\nalso misc fixes to grpc/docs and channel args\r\n\r\nthe last commit here tweaks the c header comments too to show up in doxygen, but PLMK if we don't want those - wasn't sure.\r\n\r\nPTAL I think this is ready now\r\n\r\n"},"comment":{"url":"https://api.github.com/repos/grpc/grpc/issues/comments/300860216","html_url":"https://github.com/grpc/grpc/pull/10992#issuecomment-300860216","issue_url":"https://api.github.com/repos/grpc/grpc/issues/10992","id":300860216,"user":{"login":"markdroth","id":18664614,"avatar_url":"https://avatars1.githubusercontent.com/u/18664614?v=3","gravatar_id":"","url":"https://api.github.com/users/markdroth","html_url":"https://github.com/markdroth","followers_url":"https://api.github.com/users/markdroth/followers","following_url":"https://api.github.com/users/markdroth/following{/other_user}","gists_url":"https://api.github.com/users/markdroth/gists{/gist_id}","starred_url":"https://api.github.com/users/markdroth/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/markdroth/subscriptions","organizations_url":"https://api.github.com/users/markdroth/orgs","repos_url":"https://api.github.com/users/markdroth/repos","events_url":"https://api.github.com/users/markdroth/events{/privacy}","received_events_url":"https://api.github.com/users/markdroth/received_events","type":"User","site_admin":false},"created_at":"2017-05-11T17:29:08Z","updated_at":"2017-05-11T17:29:08Z","body":"This is looking really good!  Remaining comments are all fairly minor.\n\n---\n\nReviewed 1 of 17 files at r4, 11 of 11 files at r5.\nReview status: all files reviewed at latest revision, 10 unresolved discussions, some commit checks failed.\n\n---\n\n*[include/grpc++/impl/codegen/async_stream.h, line 75 at r5](https://reviewable.io:443/reviews/grpc/grpc/10992#-KjsVhfF6v-H8HYQTmos:-KjsVhfF6v-H8HYQTmot:b-1lrk5p) ([raw file](https://github.com/grpc/grpc/blob/d6ba5ecc343479f8a0508f3ea322fafe162d0290/include/grpc++/impl/codegen/async_stream.h#L75)):*\n> ```objc\n>   ///     earlier call to \\a AsyncReaderInterface::Read that\n>   ///     yielded a failed result\n>   ///     , e.g. cq->Next(&read_tag, &ok) filled in 'ok' with 'false').\n> ```\n\nAt least part of this can be moved onto the previous line.\n\n---\n\n*[include/grpc++/impl/codegen/async_stream.h, line 817 at r5](https://reviewable.io:443/reviews/grpc/grpc/10992#-KjsWGgjyJ-_qz0ECt-r:-KjsWGgjyJ-_qz0ECt-s:b-c2jpy0) ([raw file](https://github.com/grpc/grpc/blob/d6ba5ecc343479f8a0508f3ea322fafe162d0290/include/grpc++/impl/codegen/async_stream.h#L817)):*\n> ```objc\n>   ///\n>   /// This operation will end when the server has finished sending out initial\n>   /// metadata\n> ```\n\nThis can be moved to the previous line.\n\n---\n\n*[include/grpc++/impl/codegen/async_unary_call.h, line 51 at r3](https://reviewable.io:443/reviews/grpc/grpc/10992#-KjOd60r1y2oB5q6mCJi:-KjsWaZxcaOdzZdhe4LQ:bwesx4j) ([raw file](https://github.com/grpc/grpc/blob/9b7e3b3dea8825df87a81f1a05e2ee8f740290a0/include/grpc++/impl/codegen/async_unary_call.h#L51)):*\n<details><summary><i>Previously, markdroth (Mark D. Roth) wrote…</i></summary><blockquote>\n\nDoesn't look like this was done.\n</blockquote></details>\n\nStill need a top-level comment documenting what this class is for.\n\n---\n\n*[include/grpc++/impl/codegen/client_context.h, line 253 at r4](https://reviewable.io:443/reviews/grpc/grpc/10992#-KjnJxdEfoBiguSLp2XN:-KjsXB-EWSSwVwgfRCL3:bhvs5cu) ([raw file](https://github.com/grpc/grpc/blob/0f02908e67d637acfff579c2a97be20ebfca1b00/include/grpc++/impl/codegen/client_context.h#L253)):*\n<details><summary><i>Previously, markdroth (Mark D. Roth) wrote…</i></summary><blockquote>\n\ns/RPC made/RPC is made/\n</blockquote></details>\n\nDoesn't look like this was done.\n\n---\n\n*[include/grpc++/impl/codegen/client_context.h, line 195 at r5](https://reviewable.io:443/reviews/grpc/grpc/10992#-KjsWrkKekWqc-53jP8G:-KjsWrkKekWqc-53jP8H:bxxoa0a) ([raw file](https://github.com/grpc/grpc/blob/d6ba5ecc343479f8a0508f3ea322fafe162d0290/include/grpc++/impl/codegen/client_context.h#L195)):*\n> ```objc\n>   /// \\param meta_key The metadata key. If \\a meta_value is binary data, it must\n>   /// end in \"-bin\".\n>   /// \\param meta_value The metadata value. If its value is binary, it must be\n> ```\n\ns/it must be/the key name must/\n\n---\n\n*[include/grpc++/impl/codegen/server_context.h, line 133 at r5](https://reviewable.io:443/reviews/grpc/grpc/10992#-KjsXJIBo0NIr6IWfkD9:-KjsXJIBo0NIr6IWfkDA:b-8yg75i) ([raw file](https://github.com/grpc/grpc/blob/d6ba5ecc343479f8a0508f3ea322fafe162d0290/include/grpc++/impl/codegen/server_context.h#L133)):*\n> ```objc\n>   /// it must end in \"-bin\".\n>   /// \\param meta_value The metadata value. If its value is binary,\n>   /// it must be must end in \"-bin\".\n> ```\n\ns/it must be must/the key must/\n\n---\n\n*[include/grpc++/impl/codegen/server_context.h, line 147 at r5](https://reviewable.io:443/reviews/grpc/grpc/10992#-KjsXQNgn7LBGgnXE_Kc:-KjsXQNgn7LBGgnXE_Kd:br0xvu5) ([raw file](https://github.com/grpc/grpc/blob/d6ba5ecc343479f8a0508f3ea322fafe162d0290/include/grpc++/impl/codegen/server_context.h#L147)):*\n> ```objc\n>   /// it must end in \"-bin\".\n>   /// \\param meta_value The metadata value. If its value is binary,\n>   /// it must be end in \"-bin\".\n> ```\n\ns/it must be/the key must/\n\n---\n\n*[include/grpc++/impl/codegen/server_context.h, line 156 at r5](https://reviewable.io:443/reviews/grpc/grpc/10992#-KjsXUWupfeS3RTnNfrK:-KjsXUWupfeS3RTnNfrL:bfoj649) ([raw file](https://github.com/grpc/grpc/blob/d6ba5ecc343479f8a0508f3ea322fafe162d0290/include/grpc++/impl/codegen/server_context.h#L156)):*\n> ```objc\n> \n>   /// Cancel the Call from the server. This is a best-effort API and\n>   /// depending :on when it is called, the RPC may still appear successful to\n> ```\n\ns/:on/on/\n\n---\n\n*[include/grpc++/impl/codegen/sync_stream.h, line 226 at r5](https://reviewable.io:443/reviews/grpc/grpc/10992#-KjsXoLwyGSv7yn7NSnl:-KjsXoLwyGSv7yn7NSnm:b-c2jpy0) ([raw file](https://github.com/grpc/grpc/blob/d6ba5ecc343479f8a0508f3ea322fafe162d0290/include/grpc++/impl/codegen/sync_stream.h#L226)):*\n> ```objc\n>   ///   already received (if initial metadata is received, it can be then\n>   ///   accessed\n>   ///   through the \\a ClientContext associated with this call).\n> ```\n\nThis can be moved to the previous line.\n\n---\n\n*[include/grpc/impl/codegen/grpc_types.h, line 276 at r4](https://reviewable.io:443/reviews/grpc/grpc/10992#-KjnMfQV76yzPo6aIwpo:-KjsYE2-Rj6dxlcYxJOB:b-kwj0wo) ([raw file](https://github.com/grpc/grpc/blob/0f02908e67d637acfff579c2a97be20ebfca1b00/include/grpc/impl/codegen/grpc_types.h#L276)):*\n<details><summary><i>Previously, markdroth (Mark D. Roth) wrote…</i></summary><blockquote>\n\nSame here.\n</blockquote></details>\n\nThis comment still seems to be spread across way more lines that it actually needs.\n\n---\n\n\n*Comments from [Reviewable](https://reviewable.io:443/reviews/grpc/grpc/10992#-:-KjsYaO7EsGEyUPq_qBu:bwy01ts)*\n<!-- Sent from Reviewable.io -->\n"}}
{"actor":{"display_login":"markdroth"}}