iox-eclipse-iceoryx#743 Fix include issue

Signed-off-by: Simon Hoinkis <[email protected]>
ApexAI · Apr 16, 2021 · f03a33d · f03a33d
1 parent 2c95bf9
commit f03a33d
Show file tree

Hide file tree

Showing 17 changed files with 47 additions and 16 deletions.
diff --git a/doc/design/draft/draft.puml b/doc/design/draft/draft.puml
@@ -0,0 +1,31 @@
+@startuml
+object ProcessManager {
+    creates objects and
+    handles discovery
+}
+object ProcessAlice
+object ProcessBob
+object NodeSubscriber
+object NodePublisher
+object PublisherRadar
+object PublisherVideo
+object SubscriberRadar
+object SubscriberVideo
+object WaitSet
+object Listener
+object EventVariableA
+object EventVariableB
+
+ProcessManager o-- ProcessAlice : <<creates>>
+ProcessManager o-- ProcessBob : <<creates>>
+ProcessBob "1" *-- "1..*" NodePublisher
+NodeSubscriber "1" *-- "0..*" PublisherRadar
+NodeSubscriber "1" *-- "0..*" PublisherVideo
+ProcessAlice "1" *-- "1..*" NodeSubscriber
+NodePublisher "1" *-- "0..*" SubscriberRadar
+NodePublisher "1" *-- "0..*" SubscriberVideo
+NodePublisher "1" *-- "0..*" WaitSet
+NodePublisher "1" *-- "0..*" Listener
+WaitSet "1" *-- "1" EventVariableA
+Listener "1" *-- "1" EventVariableB
+@enduml
diff --git a/doc/website/advanced/iceoryx_utils.md b/doc/website/advanced/iceoryx_utils.md
@@ -1,4 +1,4 @@
 ---
 title: Safe building blocks
 ---
-{! ./../iceoryx_utils/README.md !}
+{! ../iceoryx/iceoryx_utils/README.md !}
diff --git a/doc/website/getting-started/examples/callbacks.md b/doc/website/getting-started/examples/callbacks.md
@@ -2,4 +2,4 @@
 title: Implementing event triggered callbacks using C++
 ---
 
-{! ./../iceoryx_examples/callbacks/README.md !}
+{! ../iceoryx/iceoryx_examples/callbacks/README.md !}
diff --git a/doc/website/getting-started/examples/callbacks_in_c.md b/doc/website/getting-started/examples/callbacks_in_c.md
@@ -2,4 +2,4 @@
 title: Implementing event triggered callbacks using C
 ---
 
-{! ./../iceoryx_examples/callbacks_in_c/README.md !}
+{! ../iceoryx/iceoryx_examples/callbacks_in_c/README.md !}
diff --git a/doc/website/getting-started/examples/ice_access_control.md b/doc/website/getting-started/examples/ice_access_control.md
@@ -2,4 +2,4 @@
 title: Configuring access rights for shared memory segments
 ---
 
-{! ./../iceoryx_examples/ice_access_control/README.md !}
+{! ../iceoryx/iceoryx_examples/ice_access_control/README.md !}
diff --git a/doc/website/getting-started/examples/icecrystal.md b/doc/website/getting-started/examples/icecrystal.md
@@ -2,4 +2,4 @@
 title: Using the introspection client for debugging
 ---
 
-{! ./../iceoryx_examples/icecrystal/Readme.md !}
+{! ../iceoryx/iceoryx_examples/icecrystal/Readme.md !}
diff --git a/doc/website/getting-started/examples/icedelivery.md b/doc/website/getting-started/examples/icedelivery.md
@@ -2,4 +2,4 @@
 title: Sending and receiving data using C++
 ---
 
-{! ./../iceoryx_examples/icedelivery/README.md !}
+{! ../iceoryx/iceoryx_examples/icedelivery/README.md !}
diff --git a/doc/website/getting-started/examples/icedelivery_in_c.md b/doc/website/getting-started/examples/icedelivery_in_c.md
@@ -2,4 +2,4 @@
 title: Sending and receiving data using C
 ---
 
-{! ./../iceoryx_examples/icedelivery_in_c/README.md !}
+{! ../iceoryx/iceoryx_examples/icedelivery_in_c/README.md !}
diff --git a/doc/website/getting-started/examples/iceensemble.md b/doc/website/getting-started/examples/iceensemble.md
@@ -2,4 +2,4 @@
 title: Using multiple publishers for one topic
 ---
 
-{! ./../iceoryx_examples/iceensemble/README.md !}
+{! ../iceoryx/iceoryx_examples/iceensemble/README.md !}
diff --git a/doc/website/getting-started/examples/icehello.md b/doc/website/getting-started/examples/icehello.md
@@ -2,4 +2,4 @@
 title: Sending data to another process
 ---
 
-{! ./../iceoryx_examples/icehello/README.md !}
+{! ../iceoryx/iceoryx_examples/icehello/README.md !}
diff --git a/doc/website/getting-started/examples/iceoptions.md b/doc/website/getting-started/examples/iceoptions.md
@@ -2,4 +2,4 @@
 title: Configuring pub/sub settings like history cache size or startup behaviour
 ---
 
-{! ./../iceoryx_examples/iceoptions/README.md !}
+{! ../iceoryx/iceoryx_examples/iceoptions/README.md !}
diff --git a/doc/website/getting-started/examples/iceperf.md b/doc/website/getting-started/examples/iceperf.md
@@ -2,4 +2,4 @@
 title: Measuring the latency of different IPC mechanisms
 ---
 
-{! ./../iceoryx_examples/iceperf/README.md !}
+{! ../iceoryx/iceoryx_examples/iceperf/README.md !}
diff --git a/doc/website/getting-started/examples/index.md b/doc/website/getting-started/examples/index.md
@@ -2,4 +2,4 @@
 title: List of examples
 ---
 
-{! ./../iceoryx_examples/README.md !}
+{! ../iceoryx/iceoryx_examples/README.md !}
diff --git a/doc/website/getting-started/examples/singleprocess.md b/doc/website/getting-started/examples/singleprocess.md
@@ -2,4 +2,4 @@
 title: Communicating in a single process between threads
 ---
 
-{! ./../iceoryx_examples/singleprocess/README.md !}
+{! ../iceoryx/iceoryx_examples/singleprocess/README.md !}
diff --git a/doc/website/getting-started/examples/waitset.md b/doc/website/getting-started/examples/waitset.md
@@ -1,4 +1,4 @@
 ---
 title: Waiting for events like arrival of data using C++
 ---
-{! ./../iceoryx_examples/waitset/README.md !}
+{! ../iceoryx/iceoryx_examples/waitset/README.md !}
diff --git a/doc/website/getting-started/examples/waitset_in_c.md b/doc/website/getting-started/examples/waitset_in_c.md
@@ -2,4 +2,4 @@
 title: Waiting for events like arrival of data using C
 ---
 
-{! ./../iceoryx_examples/waitset_in_c/README.md !}
+{! ../iceoryx/iceoryx_examples/waitset_in_c/README.md !}
diff --git a/doc/website/index.md b/doc/website/index.md
@@ -12,5 +12,5 @@ Eclipse iceoryx™ is a true zero-copy inter-process communication that allows v
 
 | <h2>:octicons-stopwatch-16: Easy</h2> | <h2>:material-shield-half-full: Safe</h2> | <h2>:material-truck-fast: Fast</h2> |
 |----|----|-----|
-|<ul><li>Simple publish-subscribe API with service discovery</li><li>Straightforward usage for ROS2 and Adaptive AUTOSAR</li><li>Runs on QNX, Linux, MacOS and Windows</li></ul>|<ul><li>Automotive-grade (ISO26262 certification ongoing)</li><li>Lock-free algorithms prevent deadlocks</li><li>Huge library with safe STL implementations</li></ul>|<ul><li>Written in C++14</li><li>C binding available</li><li>Zero-copy data transmission with shared memory</li><li>Ultra low latency</li></ul>|
+|<ul><li>Simple publish-subscribe API with service discovery</li><li>Straightforward usage for ROS2 and Adaptive AUTOSAR</li><li>Runs on QNX, Linux, MacOS and Windows</li></ul>|<ul><li>Automotive-grade (ISO26262 certification ongoing)</li><li>Lock-free algorithms prevent deadlocks</li><li>Huge STL with safe implementations</li></ul>|<ul><li>Written in C++14</li><li>C binding available</li><li>Zero-copy data transmission with shared memory</li><li>Ultra low latency</li></ul>|
 |[Learn more](getting-started/what-is-iceoryx.md#easy){ .md-button }|[Learn more ](getting-started/what-is-iceoryx.md#safe){ .md-button }|[Learn more](getting-started/what-is-iceoryx.md#fast){ .md-button }|