pulsar icon indicating copy to clipboard operation
pulsar copied to clipboard
verified publisher icon apache

[Doc] C++ Client API docs are incompleted

Open tisonkun opened this issue 3 years ago • 4 comments

Search before asking

  • [X] I searched in the issues and found nothing similar.

What issue do you find in Pulsar docs?

If you check https://pulsar.apache.org/api/cpp/

image

There's no stable release after 2.5.0. All are snapshots and don't distinguish by patch versions.

What is your suggestion?

Figure out the reason, regenerate the content, and fix references to these pages.

cc @urfreespace @BewareMyPower

Any reference?

No response

Are you willing to submit a PR?

  • [ ] I'm willing to submit a PR!

tisonkun avatar Sep 07 '22 02:09 tisonkun

I realized this issue as well. The release process doesn't include the release of C++ docs.

BewareMyPower avatar Sep 07 '22 03:09 BewareMyPower

The issue had no activity for 30 days, mark with Stale label.

github-actions[bot] avatar Oct 15 '22 02:10 github-actions[bot]

cc @BewareMyPower @Anonymitaet @merlimat @michaeljmarshall

May I ask how we generate C++ API docs now? I don't find an entry talking about it...

tisonkun avatar Nov 03 '22 16:11 tisonkun

@tisonkun https://github.com/apache/pulsar-client-cpp/pull/103 will fix the doxygen generation.

BewareMyPower avatar Nov 03 '22 17:11 BewareMyPower