libheif icon indicating copy to clipboard operation
libheif copied to clipboard

[Request] Add option for docs

Open L4cache opened this issue 1 year ago • 6 comments

An option to turn on and off the generation of docs will be nice. I'm implementing a process of building libheif for media-autobuild_suite, I've encountered errors with doxygen, as we are building the command line tool, I think we can disable the docs. But of course fixing the docs generation is also appreciated.

L4cache avatar Nov 21 '24 08:11 L4cache

It might be better to split these (since they're essentially unrelated). Also, for the doxygen one, can you show the error(s)?

bradh avatar Nov 21 '24 08:11 bradh

FAILED: CMakeFiles/doc_doxygen C:/mabsl/libheif/build/CMakeFiles/doc_doxygen
C:\Windows\system32\cmd.exe /C "cd /D C:\mabsl\libheif\build && C:\mabsl\msys64\usr\bin\doxygen.exe C:/mabsl/libheif/build/Doxyfile"
warning: Tag 'CLANG_ASSISTED_PARSING' at line 1155 of file 'C:/mabsl/libheif/build/Doxyfile' belongs to an option that was not enabled at compile time.
         To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u", or recompile doxygen with this feature enabled.
warning: Tag 'CLANG_ADD_INC_PATHS' at line 1161 of file 'C:/mabsl/libheif/build/Doxyfile' belongs to an option that was not enabled at compile time.
         To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u", or recompile doxygen with this feature enabled.
warning: Tag 'CLANG_OPTIONS' at line 1169 of file 'C:/mabsl/libheif/build/Doxyfile' belongs to an option that was not enabled at compile time.
         To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u", or recompile doxygen with this feature enabled.
warning: Tag 'CLANG_DATABASE_PATH' at line 1182 of file 'C:/mabsl/libheif/build/Doxyfile' belongs to an option that was not enabled at compile time.
         To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u", or recompile doxygen with this feature enabled.
error: tag OUTPUT_DIRECTORY: Output directory 'C:/mabsl/libheif/build/apidoc/' does not exist and cannot be created
ninja: build stopped: subcommand failed.

L4cache avatar Nov 21 '24 08:11 L4cache

See also https://github.com/strukturag/libheif/issues/979

kmilos avatar Nov 21 '24 09:11 kmilos

So the warnings are expected and the error looks like an artefact of the build system.

If that cannot be fixed a cmake option could be added.

bradh avatar Nov 21 '24 10:11 bradh

Did you work out why the build system cannot create that directory?

bradh avatar Jan 08 '25 10:01 bradh

I don't know why, but I suspect that it's path related, the conversion between Windows and Unix style and the expansion of relative path for example.

L4cache avatar Jan 08 '25 18:01 L4cache