5p4k / respiration_issues

Reproduce issues with Breathe, Exhale, Sphinx and Doxygen

Issues with Breathe, Exhale, Sphinx and Doxygen

This projects is just intended to reproduce a series of issues in using Exhale, which is based on Breathe, which calls Sphinx and Doxygen. These may occur in any of the four projects, I don't know yet.

Some of these issues are fixed by Breathe's PR #512.

Reproducing the issues

$ virtualenv -p python3 venv
$ source venv/bin/activate
(venv) $ pip install -r docs/requirements.txt
(venv) $ cd docs
(venv) $ make clean
(venv) $ make html
Running Sphinx v3.1.0+/4248ddd
making output directory... done
[~] Exhale: executing doxygen.
Notice: Output directory './respiration_issues/docs/doxyoutput' does not exist. I have created it for you.
Searching for include files...
Searching for example files...
Searching for images...
Searching for dot files...
Searching for msc files...
Searching for dia files...
Searching for files to exclude
Searching INPUT for files to process...
Searching for files in directory ./respiration_issues/src
Reading and parsing tag files
Parsing files
Preprocessing ./respiration_issues/src/detect_idiom.h...
Parsing file ./respiration_issues/src/detect_idiom.h...
Preprocessing ./respiration_issues/src/friends.h...
Parsing file ./respiration_issues/src/friends.h...
Preprocessing ./respiration_issues/src/inheritance.h...
Parsing file ./respiration_issues/src/inheritance.h...
Preprocessing ./respiration_issues/src/main.cpp...
Parsing file ./respiration_issues/src/main.cpp...
Preprocessing ./respiration_issues/src/nested.h...
Parsing file ./respiration_issues/src/nested.h...
Preprocessing ./respiration_issues/src/parse.h...
Parsing file ./respiration_issues/src/parse.h...
Preprocessing ./respiration_issues/src/stream_ins.h...
Parsing file ./respiration_issues/src/stream_ins.h...
Preprocessing ./respiration_issues/src/templ_union.h...
Parsing file ./respiration_issues/src/templ_union.h...
Preprocessing ./respiration_issues/src/templates.h...
Parsing file ./respiration_issues/src/templates.h...
Preprocessing ./respiration_issues/src/todo.h...
Parsing file ./respiration_issues/src/todo.h...
Building group list...
Building directory list...
Building namespace list...
Building file list...
Building class list...
Computing nesting relations for classes...
Associating documentation with classes...
Building example list...
Searching for enumerations...
Searching for documented typedefs...
Searching for members imported via using declarations...
Searching for included using directives...
Searching for documented variables...
Building interface member list...
Building member list...
Searching for friends...
Searching for documented defines...
Computing class inheritance relations...
Computing class usage relations...
Flushing cached template relations that have become invalid...
Computing class relations...
Add enum values to enums...
Searching for member function documentation...
Creating members for template instances...
Building page list...
Search for main page...
Computing page relations...
Determining the scope of groups...
Sorting lists...
Determining which enums are documented
Computing member relations...
Building full member lists recursively...
Adding members to member groups.
Computing member references...
Inheriting documentation...
Generating disk names...
Adding source references...
Adding xrefitems...
Sorting member lists...
Setting anonymous enum type...
Computing dependencies between directories...
Generating citations page...
Counting members...
Counting data structures...
Resolving user defined references...
Finding anchors and sections in the documentation...
Transferring function references...
Combining using relations...
Adding members to index pages...
Correcting members for VHDL...
Generating style sheet...
Generating search indices...
Generating example documentation...
Generating file sources...
Generating code for file src/detect_idiom.h...
Generating code for file src/friends.h...
Generating code for file src/inheritance.h...
Generating code for file src/nested.h...
Generating code for file src/parse.h...
Generating code for file src/stream_ins.h...
Generating code for file src/templ_union.h...
Generating code for file src/templates.h...
Generating code for file src/todo.h...
Generating file documentation...
Generating page documentation...
Generating docs for page todo...
Generating group documentation...
Generating class documentation...
Generating namespace index...
Generating docs for compound friends::friendly...
Generating docs for compound friends::private_friend_b...
Generating docs for compound friends::protective_friend_a...
Generating docs for compound inherit::child...
Generating docs for compound inherit::parent...
Generating docs for compound nested::parent...
Generating docs for nested compound nested::parent::nested...
Generating docs for compound stream_ins::some_unrelated_struct...
Generating docs for compound stream_ins::streamable...
Generating docs for compound templ_union::ti_map...
Generating docs for compound templates::container...
Generating docs for compound todo::incomplete_class...
Generating graph info page...
Generating directory documentation...
finalizing index lists...
writing tag file...
Generating XML output...
Generating XML output for class inherit::child
Generating XML output for class templates::container
Generating XML output for class friends::friendly
Generating XML output for class todo::incomplete_class
Generating XML output for class nested::parent::nested
Generating XML output for class inherit::parent
Generating XML output for class nested::parent
Generating XML output for class friends::private_friend_b
Generating XML output for class friends::protective_friend_a
Generating XML output for class stream_ins::some_unrelated_struct
Generating XML output for class stream_ins::streamable
Generating XML output for class templ_union::ti_map
Generating XML output for namespace detect
Generating XML output for namespace friends
Generating XML output for namespace inherit
Generating XML output for namespace nested
Generating XML output for namespace parse
Generating XML output for namespace stream_ins
Generating XML output for namespace templ_union
Generating XML output for namespace templates
Generating XML output for namespace todo
Generating XML output for file detect_idiom.h
Generating XML output for file friends.h
Generating XML output for file inheritance.h
Generating XML output for file main.cpp
Generating XML output for file nested.h
Generating XML output for file parse.h
Generating XML output for file stream_ins.h
Generating XML output for file templ_union.h
Generating XML output for file templates.h
Generating XML output for file todo.h
Generating XML output for page todo
Generate XML output for dir ./respiration_issues/src/
Running plantuml with JAVA...
lookup cache used 52/65536 hits=180 misses=53
finished...

[+] Exhale: doxygen ran successfully in 0.05 seconds.
[~] Exhale: adding tree view css / javascript.
[+] Exhale: added tree view css / javascript.
[~] Exhale: parsing Doxygen XML.
[+] Exhale: finished parsing Doxygen XML in 0.11 seconds.
[~] Exhale: generating reStructuredText documents.
(!) Unabridged API: unexpected kind 'page' (IGNORED)
[+] Exhale: generated reStructuredText documents in 0.1 seconds.
building [mo]: targets for 0 po files that are out of date
building [html]: targets for 1 source files that are out of date
updating environment: [new config] 55 added, 0 changed, 0 removed
reading sources... [100%] index
./respiration_issues/docs/api/classfriends_1_1protective__friend__a.rst:13: WARNING: Error when parsing function declaration.
If the function has no return type:
  Error in declarator or parameters-and-qualifiers
  Invalid C++ declaration: Expecting "(" in parameters-and-qualifiers. [error at 38]
    friends::protective_friend_a::friendly
    --------------------------------------^
If the function has a return type:
  Error in declarator or parameters-and-qualifiers
  If pointer to member declarator:
    Invalid C++ declaration: Expected identifier in nested name. [error at 38]
      friends::protective_friend_a::friendly
      --------------------------------------^
  If declarator-id:
    Invalid C++ declaration: Expected identifier in nested name. [error at 38]
      friends::protective_friend_a::friendly
      --------------------------------------^

./respiration_issues/docs/api/classinherit_1_1parent.rst:22: WARNING: Duplicate declaration, unsigned inherit::parent::a_method()
./respiration_issues/docs/api/classnested_1_1parent_1_1nested.rst:19: WARNING: Duplicate declaration, void nested::parent::nested::this_method_will_be_duplicate() const
./respiration_issues/docs/api/classnested_1_1parent_1_1nested.rst:19: WARNING: Duplicate declaration, nested::parent::nested
./respiration_issues/docs/api/classtemplates_1_1container.rst:13: WARNING: Too many template argument lists compared to parameter lists. Argument lists: 1, Parameter lists: 0, Extra empty parameters lists prepended: 1. Declaration:
    templates::container<T>::my_vector
./respiration_issues/docs/api/function_detect__idiom_8h_1a2298a2bb5c4964236303a599d5091d1c.rst:13: WARNING: Duplicate declaration, template<class>std::false_type detect::test_something(...)
./respiration_issues/docs/api/function_detect__idiom_8h_1a69d042d6bb253247bd7b81706d6abbc6.rst:13: WARNING: Duplicate declaration, template<class T>auto detect::test_something(int)
./respiration_issues/docs/api/function_detect__idiom_8h_1a69d042d6bb253247bd7b81706d6abbc6.rst:13: WARNING: Duplicate declaration, template<class T>auto detect::test_something(int)
./respiration_issues/docs/api/function_main_8cpp_1a9b1c3880da1371929acb3582f0a1f842.rst:13: WARNING: doxygenfunction: Cannot find function "some_function_which_will_never_be_relevat" in doxygen xml output for project "Test" from directory: ./doxyoutput/xml
./respiration_issues/docs/api/function_main_8cpp_1ae66f6b31b5ad750f1fe042a706a4e3d4.rst:13: WARNING: doxygenfunction: Cannot find function "main" in doxygen xml output for project "Test" from directory: ./doxyoutput/xml
./respiration_issues/docs/api/function_stream__ins_8h_1a5fbd536323e164a0cbfc52ea9189e662.rst:13: WARNING: Duplicate declaration, std::ostream& operator<<(std::ostream & o, stream_ins::some_unrelated_struct  const & d)
./respiration_issues/docs/api/typedef_parse_8h_1aca23ad7051f25ce3433da3d5ea86fb7b.rst:13: WARNING: Error in type declaration.
Invalid C++ declaration: Expected identifier in nested name, got keyword: decltype [error at 68]
  template<class Container>parse::iterator_value_t = typename decltype(std::declval<Container>().begin())::value_type
  --------------------------------------------------------------------^
./respiration_issues/docs/api/uniontempl__union_1_1ti__map.rst:13: WARNING: Invalid C++ declaration: Expected identifier in nested name, got keyword: template [error at 8]
  template<class UnsignedT> templ_union::ti_map
  --------^
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [100%] index
generating indices...  genindexdone
writing additional pages...  searchdone
copying static files... ... done
copying extra files... done
dumping search index in English (code: en)... done
dumping object inventory... done
build succeeded, 13 warnings.

The HTML pages are in build/html.