search

xiph / opusfile

Stand-alone decoder library for .opus streams
BSD 3-Clause "New" or "Revised" License
154 stars 81 forks source link

Documentation #21

Closed mattgwwalker closed 2 years ago

mattgwwalker commented 4 years ago

Hi,

It looks like there might be an issue with the documentation.

When I go to the documentation on opus-codec.org I don't see any documented functions for version 0.12. See here for an example.

This is not the case for the next most recent version of the documentation that I could find still on the website.

So, I suspect there might be a configuration issue with Doxygen. Perhaps it's a similar issue to what was seen in libopusenc (see issue number 21 there)?

Cheers,

Matthew

jakar commented 3 years ago

For what it's worth, the documentation is generated perfectly when I build locally. Maybe it just needs to be rebuilt and copied to opus-codec.org?

ghost commented 3 years ago

Got the exact same issue here, but, generating the docs from source is ok.

h3ndrk commented 3 years ago

When running Doxygen I'm getting the following warnings:

include/opusfile.h:385: warning: explicit link request to 'OP_PIC_FORMAT_UNKNOWN' could not be resolved
include/opusfile.h:386: warning: explicit link request to 'OP_PIC_FORMAT_URL' could not be resolved
include/opusfile.h:387: warning: explicit link request to 'OP_PIC_FORMAT_JPEG' could not be resolved
include/opusfile.h:388: warning: explicit link request to 'OP_PIC_FORMAT_PNG' could not be resolved
include/opusfile.h:389: warning: explicit link request to 'OP_PIC_FORMAT_GIF' could not be resolved

Maybe the warnings cause Doxygen to not progress the file further resulting in empty documentation?

rillian commented 2 years ago

This has been fixed now. Thanks for the report, and thanks to Dario-Gasquez and Alexander Traud for submitting diagnosis and fixes!