librdkafka
librdkafka copied to clipboard
CLIENTS-2514: Fixed broken links
Fixing 4 broken links in the documentation.
- Statistics Schema JSON
- transaction.c example file
- rdkafka.h src file
- rdkafka_ssl.c src file
The links are broken in this doc - https://docs.confluent.io/platform/current/clients/librdkafka/html/md_INTRODUCTION.html
Please verify here. In github, all the links except statistics_schema.json works fine.
If we see Doxyfile, we can see that we are not generating examples or src file documentations except for rdkafka.h . Hence, I kept absolute links.
https://github.com/edenhill/librdkafka/blob/master/Doxyfile#L767
Ah, thanks for clarifying -- so it seems like in the example for rdkafka.h, it should point to https://docs.confluent.io/platform/current/clients/librdkafka/html/rdkafka_8h.html. I am not sure how we fix this for doxygen while not providing the absolute path.
Ah, thanks for clarifying -- so it seems like in the example for
rdkafka.h, it should point to https://docs.confluent.io/platform/current/clients/librdkafka/html/rdkafka_8h.html. I am not sure how we fix this for doxygen while not providing the absolute path.
If we use rdkafka.h, it directly points to https://docs.confluent.io/platform/current/clients/librdkafka/html/rdkafka_8h.html in the docs. (search for rdkafka.h in https://docs.confluent.io/platform/current/clients/librdkafka/html/md_INTRODUCTION.html)
In github, we just specify rdkafka.h. (example - https://github.com/edenhill/librdkafka/blob/master/INTRODUCTION.md#simple-consumer-api-legacy)