[qpid-proton] branch main updated: PROTON-2653: [cpp] Move tracing.dox to docs folder

[as...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

astitcher pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/qpid-proton.git


The following commit(s) were added to refs/heads/main by this push:
     new 21280a08a PROTON-2653: [cpp] Move tracing.dox to docs folder
21280a08a is described below

commit 21280a08a9c673393fb7dd01dfd2f05f36378722
Author: Rakhi Kumari <ra...@gmail.com>
AuthorDate: Thu Dec 8 13:53:53 2022 +0530

    PROTON-2653: [cpp] Move tracing.dox to docs folder
    
    Tracing documentation(example/tracing.dox) was not getting picked up automatically by the qpid-site script as per already defined paths.
    Hence, it was not visible on the qpid webiste.
---
 cpp/{examples => docs}/tracing.dox |  0
 cpp/examples/README.dox            | 16 ++++++++++++++++
 2 files changed, 16 insertions(+)

diff --git a/cpp/examples/tracing.dox b/cpp/docs/tracing.dox
similarity index 100%
rename from cpp/examples/tracing.dox
rename to cpp/docs/tracing.dox
diff --git a/cpp/examples/README.dox b/cpp/examples/README.dox
index cb25e489c..dddb1a15a 100644
--- a/cpp/examples/README.dox
+++ b/cpp/examples/README.dox
@@ -137,3 +137,19 @@ A multithreaded sender and receiver enhanced for flow control.
 __Requires C++11__
 
 */
+
+/** @example tracing_client.cpp
+
+A client part of a request-response example demonstrating the use of tracing. Send requests
+and receive responses from the tracing_server. Traces and spans are displayed on Jaeger UI.
+For detailed information, tracing documentation(tracing.dox) can be found in docs folder.
+
+*/
+
+/** @example tracing_server.cpp
+
+A server part of a request-response example demonstrating the use of tracing. Receive requests
+and send responses back to the tracing_client. Traces and spans are displayed on Jaeger UI.
+For detailed information, tracing documentation(tracing.dox) can be found in docs folder.
+
+*/


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@qpid.apache.org
For additional commands, e-mail: commits-help@qpid.apache.org