You are viewing a plain text version of this content. The canonical link for it is here.

Posted to commits@pulsar.apache.org by GitBox <gi...@apache.org> on 2021/01/22 14:51:23 UTC

[GitHub] [pulsar] BewareMyPower commented on issue #9282: [Doc] C++ client's doc is poor

BewareMyPower commented on issue #9282:
URL: https://github.com/apache/pulsar/issues/9282#issuecomment-765456121


   As the generated docs in my local environment, here's an example from #9287 
   
   <img width="1160" alt="截屏2021-01-22 下午10 45 28" src="https://user-images.githubusercontent.com/18204803/105505215-a46faf80-5d03-11eb-865e-83cb0a7d9737.png">
   
   As we can see, we can link `ProducerConfiguration`'s related methods from `Producer#send`. However it requires these external methods have JavaDoc style comments. If not, these methods cannot be linked, like the current C++ API website:
   
   <img width="884" alt="截屏2021-01-22 下午10 50 12" src="https://user-images.githubusercontent.com/18204803/105505691-3a0b3f00-5d04-11eb-8dda-b41a9f798f12.png">
   
   The methods with dark bold text are not documented and have no link.
   


----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org