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

Directions for generating documentation are wrong #512

Open
Windwoes opened this issue Jun 17, 2024 · 0 comments
Open

Directions for generating documentation are wrong #512

Windwoes opened this issue Jun 17, 2024 · 0 comments

Comments

@Windwoes
Copy link

The directions for generating the documentation say

The documentation of the functions of OpENer is part of the source code. The source packages contain the generated documentation in the directory doc/api_doc. If you use the GIT version you will need the program Doxygen for generating the HTML documentation. You can generate the documentation by invoking doxygen from the command line in the opener main directory.

This doesn't work. It results in:

warning: Tag 'TCL_SUBST' at line 237 of file 'source/opener.doxyfile.in' has become obsolete.
         To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'COLS_IN_ALPHA_INDEX' at line 1020 of file 'source/opener.doxyfile.in' has become obsolete.
         To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'PERL_PATH' at line 2073 of file 'source/opener.doxyfile.in' has become obsolete.
         To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'MSCGEN_PATH' at line 2095 of file 'source/opener.doxyfile.in' has become obsolete.
         To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: argument 'a4wide' for option PAPER_TYPE is not a valid enum value
Using the default: a4!
warning: tag INPUT: input source '@OpENer_SOURCE_DIR@/src' does not exist
warning: tag INPUT: input source '@PROJECT_BINARY_DIR@/src/ports/devicedata.h' does not exist
Doxygen version used: 1.9.1
error: tag OUTPUT_DIRECTORY: Output directory '@OpENer_BINARY_DIR@/api_doc' does not exist and cannot be created
Exiting...

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

1 participant