Weston Pace created ARROW-13316:
-----------------------------------
Summary: [Python][C++][Doc] Fix warnings generated by sphinx when
incorporating doxygen docs
Key: ARROW-13316
URL: https://issues.apache.org/jira/browse/ARROW-13316
Project: Apache Arrow
Issue Type: Improvement
Components: C++, Documentation, Python
Reporter: Weston Pace
Sphinx interprets the doxygen output to build the final documentation. This
process generates some warnings.
This warning is generated when running doxygen:
{code:java}
warning: Tag 'COLS_IN_ALPHA_INDEX' at line 1118 of file 'Doxyfile' has become
obsolete.
To avoid this warning please remove this line from your configuration
file or upgrade it using "doxygen -u"
{code}
There are many warnings contributed to compute.rst that look like this (it is
unclear where this static constexpr static is coming from as it is not present
in the repo or doxygen that I can find):
{code:java}
/home/pace/dev/arrow/docs/source/cpp/api/compute.rst:51: WARNING: Invalid C++
declaration: Expected identifier in nested name, got keyword: static [error at
23]
static constexpr static char const kTypeName [] = "ScalarAggregateOptions"
{code}
There is a duplicate definition warning (I think this one is because the doc
comment is present on both the definition and the override)
{code:java}
/home/pace/dev/arrow/docs/source/cpp/api/dataset.rst:69: WARNING: Duplicate
declaration, Result< std::shared_ptr< FileFragment > > MakeFragment (FileSource
source, compute::Expression partition_expression, std::shared_ptr< Schema >
physical_schema)
{code}
Finally, there is a specific issue with the GetRecordBatchGenerator function
{code:java}
/home/pace/dev/arrow/docs/source/cpp/api/formats.rst:80: WARNING: Error when
parsing function declaration.
If the function has no return type:
Error in declarator or parameters-and-qualifiers
Main error:
Invalid C++ declaration: Expecting "(" in parameters-and-qualifiers. [error
at 23]
virtual ::arrow::Result< std::function<::arrow::Future<
std::shared_ptr<::arrow::RecordBatch > >)> > GetRecordBatchGenerator
(std::shared_ptr< FileReader > reader, const std::vector< int >
row_group_indices, const std::vector< int > column_indices,
::arrow::internal::Executor *cpu_executor=NULLPTR)=0
-----------------------^
Potential other error:
Error in parsing template argument list.
If type argument:
Main error:
Invalid C++ declaration: Expected "...>", ">" or "," in template
argument list. [error at 38]
virtual ::arrow::Result< std::function<::arrow::Future<
std::shared_ptr<::arrow::RecordBatch > >)> > GetRecordBatchGenerator
(std::shared_ptr< FileReader > reader, const std::vector< int >
row_group_indices, const std::vector< int > column_indices,
::arrow::internal::Executor *cpu_executor=NULLPTR)=0
--------------------------------------^
Potential other error:
Main error:
Invalid C++ declaration: Expected identifier in nested name. [error
at 38]
virtual ::arrow::Result< std::function<::arrow::Future<
std::shared_ptr<::arrow::RecordBatch > >)> > GetRecordBatchGenerator
(std::shared_ptr< FileReader > reader, const std::vector< int >
row_group_indices, const std::vector< int > column_indices,
::arrow::internal::Executor *cpu_executor=NULLPTR)=0
--------------------------------------^
Potential other error:
Error in parsing template argument list.
If type argument:
Invalid C++ declaration: Expected "...>", ">" or "," in template
argument list. [error at 96]
virtual ::arrow::Result< std::function<::arrow::Future<
std::shared_ptr<::arrow::RecordBatch > >)> > GetRecordBatchGenerator
(std::shared_ptr< FileReader > reader, const std::vector< int >
row_group_indices, const std::vector< int > column_indices,
::arrow::internal::Executor *cpu_executor=NULLPTR)=0
------------------------------------------------------------------------------------------------^
If non-type argument:
Invalid C++ declaration: Expected "...>", ">" or "," in template
argument list. [error at 96]
virtual ::arrow::Result< std::function<::arrow::Future<
std::shared_ptr<::arrow::RecordBatch > >)> > GetRecordBatchGenerator
(std::shared_ptr< FileReader > reader, const std::vector< int >
row_group_indices, const std::vector< int > column_indices,
::arrow::internal::Executor *cpu_executor=NULLPTR)=0
------------------------------------------------------------------------------------------------^
If non-type argument:
Invalid C++ declaration: Expected "...>", ">" or "," in template argument
list. [error at 96]
virtual ::arrow::Result< std::function<::arrow::Future<
std::shared_ptr<::arrow::RecordBatch > >)> > GetRecordBatchGenerator
(std::shared_ptr< FileReader > reader, const std::vector< int >
row_group_indices, const std::vector< int > column_indices,
::arrow::internal::Executor *cpu_executor=NULLPTR)=0
------------------------------------------------------------------------------------------------^
If the function has a return type:
Error in declarator or parameters-and-qualifiers
If pointer to member declarator:
Main error:
Invalid C++ declaration: Expected identifier in nested name. [error at 23]
virtual ::arrow::Result< std::function<::arrow::Future<
std::shared_ptr<::arrow::RecordBatch > >)> > GetRecordBatchGenerator
(std::shared_ptr< FileReader > reader, const std::vector< int >
row_group_indices, const std::vector< int > column_indices,
::arrow::internal::Executor *cpu_executor=NULLPTR)=0
-----------------------^
Potential other error:
Error in parsing template argument list.
If type argument:
Main error:
Invalid C++ declaration: Expected "...>", ">" or "," in template
argument list. [error at 38]
virtual ::arrow::Result< std::function<::arrow::Future<
std::shared_ptr<::arrow::RecordBatch > >)> > GetRecordBatchGenerator
(std::shared_ptr< FileReader > reader, const std::vector< int >
row_group_indices, const std::vector< int > column_indices,
::arrow::internal::Executor *cpu_executor=NULLPTR)=0
--------------------------------------^
Potential other error:
Main error:
Invalid C++ declaration: Expected identifier in nested name. [error
at 38]
virtual ::arrow::Result< std::function<::arrow::Future<
std::shared_ptr<::arrow::RecordBatch > >)> > GetRecordBatchGenerator
(std::shared_ptr< FileReader > reader, const std::vector< int >
row_group_indices, const std::vector< int > column_indices,
::arrow::internal::Executor *cpu_executor=NULLPTR)=0
--------------------------------------^
Potential other error:
Error in parsing template argument list.
If type argument:
Invalid C++ declaration: Expected "...>", ">" or "," in template
argument list. [error at 96]
virtual ::arrow::Result< std::function<::arrow::Future<
std::shared_ptr<::arrow::RecordBatch > >)> > GetRecordBatchGenerator
(std::shared_ptr< FileReader > reader, const std::vector< int >
row_group_indices, const std::vector< int > column_indices,
::arrow::internal::Executor *cpu_executor=NULLPTR)=0
------------------------------------------------------------------------------------------------^
If non-type argument:
Invalid C++ declaration: Expected "...>", ">" or "," in template
argument list. [error at 96]
virtual ::arrow::Result< std::function<::arrow::Future<
std::shared_ptr<::arrow::RecordBatch > >)> > GetRecordBatchGenerator
(std::shared_ptr< FileReader > reader, const std::vector< int >
row_group_indices, const std::vector< int > column_indices,
::arrow::internal::Executor *cpu_executor=NULLPTR)=0
------------------------------------------------------------------------------------------------^
If non-type argument:
Invalid C++ declaration: Expected "...>", ">" or "," in template
argument list. [error at 96]
virtual ::arrow::Result< std::function<::arrow::Future<
std::shared_ptr<::arrow::RecordBatch > >)> > GetRecordBatchGenerator
(std::shared_ptr< FileReader > reader, const std::vector< int >
row_group_indices, const std::vector< int > column_indices,
::arrow::internal::Executor *cpu_executor=NULLPTR)=0
------------------------------------------------------------------------------------------------^
If declarator-id:
Invalid C++ declaration: Expected identifier in nested name. [error at 23]
virtual ::arrow::Result< std::function<::arrow::Future<
std::shared_ptr<::arrow::RecordBatch > >)> > GetRecordBatchGenerator
(std::shared_ptr< FileReader > reader, const std::vector< int >
row_group_indices, const std::vector< int > column_indices,
::arrow::internal::Executor *cpu_executor=NULLPTR)=0
-----------------------^
{code}
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
