Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation updates #1888

Merged
merged 6 commits into from
Nov 29, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions docs/manual/api/dynamic.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
Dynamic Type API
================

.. doxygengroup:: dynamic_type
:project: ddsc_api_docs
:members:
11 changes: 11 additions & 0 deletions docs/manual/api/internal.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,26 @@ All functionality in this section is considered internal. You should not build a
:project: ddsc_api_docs
:members:

Testing
-------
.. doxygengroup:: testing
:project: ddsc_api_docs
:members:

Implementation
--------------
.. doxygengroup:: implementation
:project: ddsc_api_docs
:members:

Topic definition
----------------
.. doxygengroup:: topic_definition
:project: ddsc_api_docs
:members:

Convenience log category definitions
------------------------------------
.. doxygengroup:: log_categories
:project: ddsc_api_docs
:members:
6 changes: 6 additions & 0 deletions docs/manual/api/loan.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,9 @@ Loaning
.. doxygengroup:: loan
:project: ddsc_api_docs
:members:

Loaned Samples
--------------
.. doxygengroup:: loaned_sample
:project: ddsc_api_docs
:members:
6 changes: 6 additions & 0 deletions docs/manual/api/psmx.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
Publish Subscribe Message Exchange
==================================

.. doxygengroup:: psmx
:project: ddsc_api_docs
:members:
92 changes: 46 additions & 46 deletions docs/manual/config/config_file_reference.rst

Large diffs are not rendered by default.

2 changes: 2 additions & 0 deletions docs/manual/ddsc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,3 +31,5 @@ C API reference
api/serialization
api/internal
api/deprecated
api/psmx
api/dynamic
2 changes: 1 addition & 1 deletion docs/manual/doxygen.conf.in
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ WARN_IF_UNDOCUMENTED = YES
WARN_IF_DOC_ERROR = YES
WARN_NO_PARAMDOC = YES
WARN_AS_ERROR = NO
INPUT = ../../src/core/ddsc/include/dds/ ../../src/ddsrt/include/dds/ddsrt/retcode.h
INPUT = ../../src/core/ddsc/include/dds/ ../../src/ddsrt/include/dds/ddsrt/retcode.h ../../src/ddsrt/include/dds/ddsrt/log.h
FILE_PATTERNS = *.c *.idl **.h
RECURSIVE = YES
EXCLUDE_SYMLINKS = NO
Expand Down
2 changes: 1 addition & 1 deletion docs/manual/options.md
Original file line number Diff line number Diff line change
Expand Up @@ -1852,6 +1852,6 @@ The default value is: `none`
<!--- generated from _confgen.c[237308acd53897a34e8c643e16e05a61d73ffd65] -->
<!--- generated from generate_rnc.c[b50e4b7ab1d04b2bc1d361a0811247c337b74934] -->
<!--- generated from generate_md.c[789b92e422631684352909cfb8bf43f6ceb16a01] -->
<!--- generated from generate_rst.c[c35cdcdfc0bd4f10a801204a6cc5d540af696b6e] -->
<!--- generated from generate_rst.c[3c4b523fbb57c8e4a7e247379d06a8021ccc21c4] -->
<!--- generated from generate_xsd.c[6b6818d7f17a35d56c376c04ec1410427f34c0f0] -->
<!--- generated from generate_defconfig.c[63ca9d8ae2f1ce2e761c9d4c0510a45eb062d830] -->
38 changes: 7 additions & 31 deletions docs/manual/shared_memory/shared_mem_config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -63,33 +63,8 @@ The location where |var-project-short| looks for the config file is set through

export CYCLONEDDS_URI=file://cyclonedds.xml

The following optional configuration parameters in SharedMemory govern how |var-project-short| treats shared memory:

* Enable

* When set to *true* enables |var-project-short| to use shared memory for local data exchange

* Defaults to *false*

* LogLevel

* Controls the output of the iceoryx runtime and can be set to, in order of decreasing output:

* *verbose*

* *debug*

* *info* (default)

* *warn*

* *error*

* *fatal*

* *off*

The following is an example of a |var-project-short| configuration file supporting shared memory exchange:
The following is an example of a |var-project-short| configuration file supporting shared memory exchange through iceoryx.
Please check :ref:`//CycloneDDS/Domain/General/Interfaces/PubSubMessageExchange` for all configuration details.

.. code-block:: xml

Expand All @@ -98,10 +73,11 @@ The following is an example of a |var-project-short| configuration file supporti
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="https://cdds.io/config https://raw.githubusercontent.com/eclipse-cyclonedds/cyclonedds/iceoryx/etc/cyclonedds.xsd">
<Domain id="any">
<SharedMemory>
<Enable>true</Enable>
<LogLevel>info</LogLevel>
</SharedMemory>
<General>
<Interfaces>
<PubSubMessageExchange name="iox" library="psmx_iox" config="LOG_LEVEL=INFO;"/>
</Interfaces>
</General>
</Domain>
</CycloneDDS>

Expand Down
4 changes: 2 additions & 2 deletions docs/manual/shared_memory/shared_memory.rst
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Prerequisites

git clone https://github.com/eclipse-iceoryx/iceoryx.git -b release_2.0
cd iceoryx
cmake -Bbuild -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=install -DBUILD_SHARED_LIBS=ON -Hiceoryx_meta
cmake -Bbuild -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=install -DROUDI_ENVIRONMENT=on -DBUILD_SHARED_LIBS=ON -Hiceoryx_meta
cmake --build build --config Release --target install

#. Get |var-project-short| and build it with shared memory support:
Expand All @@ -51,7 +51,7 @@ Prerequisites

git clone https://github.com/eclipse-cyclonedds/cyclonedds.git
cd cyclonedds
cmake -Bbuild -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=install -DBUILD_EXAMPLES=On -DCMAKE_PREFIX_PATH=~/iceoryx/install/
cmake -Bbuild -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=install -DENABLE_ICEORYX=On -DBUILD_EXAMPLES=On -DCMAKE_PREFIX_PATH=~/iceoryx/install/
cmake --build build --config Release --target install

When the compiler has finished, the files for both iceoryx and |var-project-short| can
Expand Down
2 changes: 1 addition & 1 deletion etc/cyclonedds.rnc
Original file line number Diff line number Diff line change
Expand Up @@ -1291,6 +1291,6 @@ MIIEpAIBAAKCAQEA3HIh...AOBaaqSV37XBUJg==<br>
# generated from _confgen.c[237308acd53897a34e8c643e16e05a61d73ffd65]
# generated from generate_rnc.c[b50e4b7ab1d04b2bc1d361a0811247c337b74934]
# generated from generate_md.c[789b92e422631684352909cfb8bf43f6ceb16a01]
# generated from generate_rst.c[c35cdcdfc0bd4f10a801204a6cc5d540af696b6e]
# generated from generate_rst.c[3c4b523fbb57c8e4a7e247379d06a8021ccc21c4]
# generated from generate_xsd.c[6b6818d7f17a35d56c376c04ec1410427f34c0f0]
# generated from generate_defconfig.c[63ca9d8ae2f1ce2e761c9d4c0510a45eb062d830]
2 changes: 1 addition & 1 deletion etc/cyclonedds.xsd
Original file line number Diff line number Diff line change
Expand Up @@ -1947,6 +1947,6 @@ MIIEpAIBAAKCAQEA3HIh...AOBaaqSV37XBUJg==&lt;br&gt;
<!--- generated from _confgen.c[237308acd53897a34e8c643e16e05a61d73ffd65] -->
<!--- generated from generate_rnc.c[b50e4b7ab1d04b2bc1d361a0811247c337b74934] -->
<!--- generated from generate_md.c[789b92e422631684352909cfb8bf43f6ceb16a01] -->
<!--- generated from generate_rst.c[c35cdcdfc0bd4f10a801204a6cc5d540af696b6e] -->
<!--- generated from generate_rst.c[3c4b523fbb57c8e4a7e247379d06a8021ccc21c4] -->
<!--- generated from generate_xsd.c[6b6818d7f17a35d56c376c04ec1410427f34c0f0] -->
<!--- generated from generate_defconfig.c[63ca9d8ae2f1ce2e761c9d4c0510a45eb062d830] -->
Loading