svenevs / exhale

Automatic C++ library api documentation generation: breathe doxygen in and exhale it out.
BSD 3-Clause "New" or "Revised" License
219 stars 51 forks source link

"Unabridged API: unexpected kind 'page' (IGNORED)" when using @todo #88

Closed 5p4k closed 2 years ago

5p4k commented 4 years ago

It looks like using @todo in Doxygen causes this warning to pop up during build:

(!) Unabridged API: unexpected kind 'page' (IGNORED)

The todo entry is then not visible anywhere in the final documentation.

How to reproduce

    /**
     * @todo This TODO directive causes <tt>(!) Unabridged API: unexpected kind 'page' (IGNORED)</tt>
     */
    class incomplete_class {
    };

I have a separate project where I collected this and other issues (still looking to dispatch them to the right repository); you can also check that out to reproduce.

Doxygen HTML output

image

Exhale HTML output

image

svenevs commented 4 years ago

Well, that's certainly unexpected! Hmmmm. I will have to look into this page business, thanks for creating a repro example! I don't know how easy this one will be to fix, in the meantime I wonder if you can get away with just using the sphinx todo directive?

Doesn't fix the actual problem here, but I think it could be a usable workaround?

5p4k commented 4 years ago

Thanks! The todo list is more of "nice to have" for my project, but it definitely can be useful to others too.
The workaround works perfectly, but I had to

Now that's what I'm getting:

image

schmoelder commented 3 years ago

Hey, is there any update on this issue?

svenevs commented 2 years ago

as far as i know this can be closed, doxygen page support was added in #114 so i think it will work with regular old \todo in doxygen as well as the rst solution and .. todolist:: is another viable contendor

please speak up if it's not fully solved

brub43 commented 2 years ago

this also seems to happen with the @deprecated doxygen command.