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

Docs are missing most content #226

Open
pearson opened this issue Jun 25, 2021 · 0 comments
Open

Docs are missing most content #226

pearson opened this issue Jun 25, 2021 · 0 comments

Comments

@pearson
Copy link

pearson commented Jun 25, 2021

With a current clone of gattlib (last check-in Wed Jun 9 17:41:20 2021 +0200) on a Raspberry Pi 4 running the 64 bit Raspberry Pi OS, the documentation build is not complete.

There are no errors showing in the build output. The build was done as listed in the readme, being:

mkdir build && cd build
cmake ..
make

The one change I did make was to set GENERATE_HTML = YES in docs/Doxyfile.in.

Looking at gattlib.h, I would expect to see documentation entries for essentially everything in the file, given how extensive the comments are.

What I'm seeing is a blank main page, four typedefs listed in "Classes List", and 9 items listed in Class Members -> All (and the same ones in Variables). None of the functions listed in gattlib.h are appearing in the documentation. However, when I look at index.xml in /build/docs/docs/gattlib/doxygen/xml, I see all the expected defines and functions, etc. Perhaps I am not turning on HTML docs generation correctly?

Here are two screenshots as well.
gattlib1 gattlib2

If anyone has a suggestion as to what might be wrong here, I'd appreciate hearing it.

Thanks!

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