[ARROW-5341] [C++] Add instructions about fixing and testing for -Wdocumentation clang warnings locally

• Type: Improvement
• Status: Resolved
• Priority: Major
• Resolution: Fixed
• Fix Version/s: 0.14.0
• Component/s: C++
• Labels: pull-request-available
• External issue URL: https://github.com/apache/arrow/issues/21800
• Assignee: Ben Kietzman
• Reporter: Wes McKinney
• Created: 15/May/19 21:49
• Updated: 11/Jan/23 07:39
• Resolved: 14/Jun/19 21:48

Description

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

Issue Links

• links to: GitHub Pull Request #4578