[jira] [Comment Edited] (ARROW-5341) [C++] Add instructions about fixing and testing for -Wdocumentation clang warnings locally

["Benjamin Kietzman (JIRA)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/ARROW-5341?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16863390#comment-16863390 ] 

Benjamin Kietzman edited comment on ARROW-5341 at 6/13/19 7:21 PM:
-------------------------------------------------------------------

Which compiler were you using? I see the documentation warnings with clang but gcc doesn't support {{-Wdocumentation}}.

{code}
$ git diff
diff --git a/cpp/src/arrow/array/builder_adaptive.h b/cpp/src/arrow/array/builder_adaptive.h
index 7f2410952..63f87cebd 100644
--- a/cpp/src/arrow/array/builder_adaptive.h
+++ b/cpp/src/arrow/array/builder_adaptive.h
@@ -51,7 +51,8 @@ class ARROW_EXPORT AdaptiveIntBuilderBase : public ArrayBuilder {
     return Status::OK();
   }
 
-  void Reset() override;
+  void Reset()
+      override;  //< comment // expected-warning {{not a Doxygen trailing comment}}
   Status Resize(int64_t capacity) override;
 
  protected:

$ archery build --build-type=debug --warn-level=checkin tmp-build
$ ninja -C tmp-build
../../src/arrow/array/builder_adaptive.h:55:18: error: not a Doxygen trailing comment [-Werror,-Wdocumentation]
      override;  //< comment // expected-warning {{not a Doxygen trailing comment}}
                 ^~~
                 ///<
{code}


was (Author: bkietz):
Which compiler were you using? I see the documentation warnings with clang but gcc doesn't support {{-Wdocumentation}}.

> [C++] Add instructions about fixing and testing for -Wdocumentation clang warnings locally
> ------------------------------------------------------------------------------------------
>
>                 Key: ARROW-5341
>                 URL: https://issues.apache.org/jira/browse/ARROW-5341
>             Project: Apache Arrow
>          Issue Type: Improvement
>          Components: C++
>            Reporter: Wes McKinney
>            Assignee: Benjamin Kietzman
>            Priority: Major
>             Fix For: 0.14.0
>
>
> I found that I had to add {{-Wdocumentation}} to {{ARROW_CXXFLAGS}} to replicate docstring-related failures in CI. I'm not sure why this is being set in Travis CI but not locally (with BUILD_WARNING_LEVEL=CHECKIN), but we should make it consistent and also document that it is a requirement in the C++ development Sphinx documentation



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)