Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Request] Add option for docs #1401

Open
L4cache opened this issue Nov 21, 2024 · 4 comments
Open

[Request] Add option for docs #1401

L4cache opened this issue Nov 21, 2024 · 4 comments

Comments

@L4cache
Copy link

L4cache commented Nov 21, 2024

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.

@bradh
Copy link
Contributor

bradh commented Nov 21, 2024

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

@L4cache
Copy link
Author

L4cache commented Nov 21, 2024

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 L4cache changed the title [Request] Update vvdec find_package version and add option for docs [Request] Add option for docs Nov 21, 2024
@kmilos
Copy link
Contributor

kmilos commented Nov 21, 2024

See also #979

@bradh
Copy link
Contributor

bradh commented Nov 21, 2024

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants