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/03/11 05:15:17 UTC
[GitHub] [pulsar] Anonymitaet opened a new pull request #9880: [Workflow] Add guidelines for "how to modify c++ client api doc"
Anonymitaet opened a new pull request #9880:
URL: https://github.com/apache/pulsar/pull/9880
----------------------------------------------------------------
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
[GitHub] [pulsar] Huanli-Meng commented on a change in pull request #9880: [Workflow] Add guidelines for "how to modify c++ client api doc"
Posted by GitBox <gi...@apache.org>.
Huanli-Meng commented on a change in pull request #9880:
URL: https://github.com/apache/pulsar/pull/9880#discussion_r592085745
##########
File path: site2/README.md
##########
@@ -211,6 +211,60 @@ If you want to change the documentation for a previous version, you can access f
For more details about versioning, refer to [Versioning](https://docusaurus.io/docs/en/versioning).
+## C++ client API doc
+
+You can use the C++ client API to connect to Pulsar and handles data. [Pulsar C++ client API doc](https://pulsar.apache.org/api/cpp/https://pulsar.apache.org/api/cpp/) provides extensive implementation details and usage conventions for the C++ client.
Review comment:
connect to a Pulsar cluster?
##########
File path: site2/README.md
##########
@@ -211,6 +211,60 @@ If you want to change the documentation for a previous version, you can access f
For more details about versioning, refer to [Versioning](https://docusaurus.io/docs/en/versioning).
+## C++ client API doc
+
+You can use the C++ client API to connect to Pulsar and handles data. [Pulsar C++ client API doc](https://pulsar.apache.org/api/cpp/https://pulsar.apache.org/api/cpp/) provides extensive implementation details and usage conventions for the C++ client.
Review comment:
connect to a Pulsar cluster?
----------------------------------------------------------------
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
[GitHub] [pulsar] BewareMyPower commented on a change in pull request #9880: [Workflow] Add guidelines for "how to modify c++ client api doc"
Posted by GitBox <gi...@apache.org>.
BewareMyPower commented on a change in pull request #9880:
URL: https://github.com/apache/pulsar/pull/9880#discussion_r592121728
##########
File path: site2/README.md
##########
@@ -211,6 +211,60 @@ If you want to change the documentation for a previous version, you can access f
For more details about versioning, refer to [Versioning](https://docusaurus.io/docs/en/versioning).
+## C++ client API doc
+
+You can use the C++ client API to connect to Pulsar and handles data. [Pulsar C++ client API doc](https://pulsar.apache.org/api/cpp/https://pulsar.apache.org/api/cpp/) provides extensive implementation details and usage conventions for the C++ client.
+
+If you want to modify the C++ client API doc, follow the steps below.
+
+**Prerequisite**
+
+- [Doxygen](http://www.doxygen.nl/)
+
+ Pulsar uses [Doxygen](http://www.doxygen.nl/) to generate the C++ client API doc. Before submitting doc changes, you need to preview the docs using Doxygen.
+
+ 1. Install Doxygen.
+
+ Go to the directory `pulsar/pulsar-client-cpp` and run the command `brew install doxygen`.
+
+ 2. Create a folder for the generated HTML files.
+
+ Go to the directory `pulsar` and run the command `mkdir -p ../target/doxygen`.
+
+- [clang-format](https://www.electronjs.org/docs/development/clang-format#:~:text=clang%2Dformat%20is%20a%20tool,style%20issues%20during%20code%20reviews)
+
+ Long code lines might cause C++ API tests to fail. Consequently, before submitting doc changes, you can break long lines of code automatically using `clang-format`.
+
+ To install clang-format, go to the directory `pulsar` and run the command `brew install clang-format`.
+
+**Step**
+
+1. Modify your desired code file.
+
+ All C++ API code files are stored at [here](https://github.com/apache/pulsar/tree/master/pulsar-client-cpp/include/pulsar).
+
+ > #### Tip
+ >
+ > - Each class has its corresponding `h` file. For example, if you want to update the [ProducerConfiguration class](https://pulsar.apache.org/api/cpp/classpulsar_1_1_producer_configuration.html), you need to modify the file [ProducerConfiguration.h](https://github.com/apache/pulsar/blob/master/pulsar-client-cpp/include/pulsar/ProducerConfiguration.h).
+ >
+ > - If you want to update descriptions for member functions, you can take [Pulsar Java API doc](https://github.com/apache/pulsar/tree/master/pulsar-client-api/src/main/java/org/apache/pulsar/client/api) as references.
+
+2. Format the code file.
+
+ Go to the directory `pulsar/pulsar-client-cpp` and run the command `clang-format -i pulsar-client-cpp/include/pulsar/<your-file-name>`.
Review comment:
The command should be `clang-format -i include/pulsar/<your-file-name>`
----------------------------------------------------------------
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
[GitHub] [pulsar] BewareMyPower commented on a change in pull request #9880: [Workflow] Add guidelines for "how to modify c++ client api doc"
Posted by GitBox <gi...@apache.org>.
BewareMyPower commented on a change in pull request #9880:
URL: https://github.com/apache/pulsar/pull/9880#discussion_r592150518
##########
File path: site2/README.md
##########
@@ -211,6 +211,60 @@ If you want to change the documentation for a previous version, you can access f
For more details about versioning, refer to [Versioning](https://docusaurus.io/docs/en/versioning).
+## C++ client API doc
+
+You can use the C++ client API to connect to Pulsar and handles data. [Pulsar C++ client API doc](https://pulsar.apache.org/api/cpp/https://pulsar.apache.org/api/cpp/) provides extensive implementation details and usage conventions for the C++ client.
Review comment:
I prefer to use `a Pulsar cluster`. But I think both are good.
----------------------------------------------------------------
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
[GitHub] [pulsar] Anonymitaet commented on a change in pull request #9880: [Workflow] Add guidelines for "how to modify c++ client api doc"
Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on a change in pull request #9880:
URL: https://github.com/apache/pulsar/pull/9880#discussion_r592146798
##########
File path: site2/README.md
##########
@@ -211,6 +211,60 @@ If you want to change the documentation for a previous version, you can access f
For more details about versioning, refer to [Versioning](https://docusaurus.io/docs/en/versioning).
+## C++ client API doc
+
+You can use the C++ client API to connect to Pulsar and handles data. [Pulsar C++ client API doc](https://pulsar.apache.org/api/cpp/https://pulsar.apache.org/api/cpp/) provides extensive implementation details and usage conventions for the C++ client.
+
+If you want to modify the C++ client API doc, follow the steps below.
+
+**Prerequisite**
+
+- [Doxygen](http://www.doxygen.nl/)
+
+ Pulsar uses [Doxygen](http://www.doxygen.nl/) to generate the C++ client API doc. Before submitting doc changes, you need to preview the docs using Doxygen.
+
+ 1. Install Doxygen.
+
+ Go to the directory `pulsar/pulsar-client-cpp` and run the command `brew install doxygen`.
+
+ 2. Create a folder for the generated HTML files.
+
+ Go to the directory `pulsar` and run the command `mkdir -p ../target/doxygen`.
+
+- [clang-format](https://www.electronjs.org/docs/development/clang-format#:~:text=clang%2Dformat%20is%20a%20tool,style%20issues%20during%20code%20reviews)
+
+ Long code lines might cause C++ API tests to fail. Consequently, before submitting doc changes, you can break long lines of code automatically using `clang-format`.
+
+ To install clang-format, go to the directory `pulsar` and run the command `brew install clang-format`.
+
+**Step**
+
+1. Modify your desired code file.
+
+ All C++ API code files are stored at [here](https://github.com/apache/pulsar/tree/master/pulsar-client-cpp/include/pulsar).
+
+ > #### Tip
+ >
+ > - Each class has its corresponding `h` file. For example, if you want to update the [ProducerConfiguration class](https://pulsar.apache.org/api/cpp/classpulsar_1_1_producer_configuration.html), you need to modify the file [ProducerConfiguration.h](https://github.com/apache/pulsar/blob/master/pulsar-client-cpp/include/pulsar/ProducerConfiguration.h).
+ >
+ > - If you want to update descriptions for member functions, you can take [Pulsar Java API doc](https://github.com/apache/pulsar/tree/master/pulsar-client-api/src/main/java/org/apache/pulsar/client/api) as references.
+
+2. Format the code file.
+
+ Go to the directory `pulsar/pulsar-client-cpp` and run the command `clang-format -i pulsar-client-cpp/include/pulsar/<your-file-name>`.
Review comment:
OK
----------------------------------------------------------------
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
[GitHub] [pulsar] Anonymitaet commented on pull request #9880: [Workflow] Add guidelines for "how to modify c++ client api doc"
Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on pull request #9880:
URL: https://github.com/apache/pulsar/pull/9880#issuecomment-796460441
@BewareMyPower @Huanli-Meng @Jennifer88huang @sijia-w could you please help review? Thanks
----------------------------------------------------------------
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
[GitHub] [pulsar] sijie merged pull request #9880: [Workflow] Add guidelines for "how to modify c++ client api doc"
Posted by GitBox <gi...@apache.org>.
sijie merged pull request #9880:
URL: https://github.com/apache/pulsar/pull/9880
----------------------------------------------------------------
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
[GitHub] [pulsar] Anonymitaet commented on a change in pull request #9880: [Workflow] Add guidelines for "how to modify c++ client api doc"
Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on a change in pull request #9880:
URL: https://github.com/apache/pulsar/pull/9880#discussion_r592109551
##########
File path: site2/README.md
##########
@@ -211,6 +211,60 @@ If you want to change the documentation for a previous version, you can access f
For more details about versioning, refer to [Versioning](https://docusaurus.io/docs/en/versioning).
+## C++ client API doc
+
+You can use the C++ client API to connect to Pulsar and handles data. [Pulsar C++ client API doc](https://pulsar.apache.org/api/cpp/https://pulsar.apache.org/api/cpp/) provides extensive implementation details and usage conventions for the C++ client.
Review comment:
Think here refers to "use API to create a c++ client to connect to `Pulsar service`", so "Pulsar service" would be more accurate? @BewareMyPower
----------------------------------------------------------------
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
[GitHub] [pulsar] Anonymitaet commented on a change in pull request #9880: [Workflow] Add guidelines for "how to modify c++ client api doc"
Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on a change in pull request #9880:
URL: https://github.com/apache/pulsar/pull/9880#discussion_r592151213
##########
File path: site2/README.md
##########
@@ -211,6 +211,60 @@ If you want to change the documentation for a previous version, you can access f
For more details about versioning, refer to [Versioning](https://docusaurus.io/docs/en/versioning).
+## C++ client API doc
+
+You can use the C++ client API to connect to Pulsar and handles data. [Pulsar C++ client API doc](https://pulsar.apache.org/api/cpp/https://pulsar.apache.org/api/cpp/) provides extensive implementation details and usage conventions for the C++ client.
Review comment:
OK, I've updated it to `a Pulsar cluster`, thanks @Huanli-Meng @BewareMyPower
----------------------------------------------------------------
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
[GitHub] [pulsar] Anonymitaet commented on pull request #9880: [Workflow] Add guidelines for "how to modify c++ client api doc"
Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on pull request #9880:
URL: https://github.com/apache/pulsar/pull/9880#issuecomment-796555127
> Since `brew install` only works on MacOS, is it better to note that these install commands (`brew install xxx`) is an example from MacOS?
Yes! Thanks for reminding me of this. Added.
----------------------------------------------------------------
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
[GitHub] [pulsar] BewareMyPower commented on pull request #9880: [Workflow] Add guidelines for "how to modify c++ client api doc"
Posted by GitBox <gi...@apache.org>.
BewareMyPower commented on pull request #9880:
URL: https://github.com/apache/pulsar/pull/9880#issuecomment-796530970
Since `brew install` only works on MacOS, is it better to note that these install commands (`brew install xxx`) is an example from MacOS?
----------------------------------------------------------------
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