ci(doc): fix some doxygen errors by devjgm · Pull Request #6552

ci(doc): fix some doxygen errors by devjgm · Pull Request #6552 · googleapis/google-cloud-cpp

added 2 commits

May 12, 2021 16:45

This fixes two sets of doxygen errors:

1. It fixes the `fatal error: 'stddef.h'` errors by setting the clang
   resource-dir path.
2. After these errors, we got a bunch of errors about unable to find
   includes like `google/proto/status.pb.h`. These are fixed by
   installing our library first, then telling doxygen where to find the
   headers we installed.

In my local tests, the only remaining errors seem to be legit warnings
that we likely need to fix (in subsequent PRs).

googlebot added the cla: yes

This human has signed the Contributor License Agreement.

label

May 12, 2021

devjgm changed the title ~~Fix doxygen errors~~ ci(doc): fix some doxygen errors

May 12, 2021

devjgm marked this pull request as ready for review

May 13, 2021 00:15

devjgm added a commit to devjgm/google-cloud-cpp that referenced this pull request

May 13, 2021

Related to: googleapis#6543

This fixes doxygen + clang being unable find certain resources like
`stddef.h` by telling clang where its `-resource-dir` is. After fixing
that error, there were a bunch of missing includes of proto/grpc
headers. Those were fixed by making the `doxygen-docs` CMake target
depend on `google-cloud-cpp-protos` so that those would be generated
before trying to generate the docs. Then some include path tweaks to
make things work.

I also enabled HTML timestamping so that we can see when new docs get
published.

This change supersedes
googleapis#6552, which I'm
goign to close.

devjgm added a commit to devjgm/google-cloud-cpp that referenced this pull request

May 13, 2021

Related to: googleapis#6543

This fixes doxygen + clang being unable find certain resources like
`stddef.h` by telling clang where its `-resource-dir` is. After fixing
that error, there were a bunch of missing includes of proto/grpc
headers. Those were fixed by making the `doxygen-docs` CMake target
depend on `google-cloud-cpp-protos` so that those would be generated
before trying to generate the docs. Then some include path tweaks to
make things work.

I also enabled HTML timestamping so that we can see when new docs get
published.

This change supersedes
googleapis#6552, which I'm
goign to close.

devjgm added a commit that referenced this pull request

May 13, 2021

Related to: #6543

This fixes doxygen + clang being unable find certain resources like
`stddef.h` by telling clang where its `-resource-dir` is. After fixing
that error, there were a bunch of missing includes of proto/grpc
headers. Those were fixed by making the `doxygen-docs` CMake target
depend on `google-cloud-cpp-protos` so that those would be generated
before trying to generate the docs. Then some include path tweaks to
make things work.

I also enabled HTML timestamping so that we can see when new docs get
published.

This change supersedes
#6552, which I'm
goign to close.

devjgm deleted the fix-doxygen-errors branch

May 13, 2021 15:46

marete pushed a commit to Unoperate/bigtable-emulator that referenced this pull request

Jul 28, 2025

Related to: #6543

This fixes doxygen + clang being unable find certain resources like
`stddef.h` by telling clang where its `-resource-dir` is. After fixing
that error, there were a bunch of missing includes of proto/grpc
headers. Those were fixed by making the `doxygen-docs` CMake target
depend on `google-cloud-cpp-protos` so that those would be generated
before trying to generate the docs. Then some include path tweaks to
make things work.

I also enabled HTML timestamping so that we can see when new docs get
published.

This change supersedes
googleapis/google-cloud-cpp#6552, which I'm
goign to close.