Skip to content

Commit 2762a61

Browse files
committed
docs: update links
1 parent 9ad077d commit 2762a61

File tree

4 files changed

+9
-9
lines changed

4 files changed

+9
-9
lines changed

docs/docs/features/features.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Basic c++ knowledge is necessary.
2020

2121
### Code generation
2222

23-
Follow the documentation for the [code generation](/docs/guide/intro) in general and [CLI](/docs/cli/generate) or the [Studio](/docs/studio/intro) tools.
23+
Follow the documentation for the [code generation](/docs/guide/intro) in general and [CLI](/docs/tools/cli/generate) or the [Studio](/docs/tools/studio/intro) tools.
2424
Or try first the [quick start guide](../quickstart/index.md) which shows how to prepare api and generate code out of it.
2525

2626
:::tip
@@ -50,11 +50,11 @@ Features generate a view model for the _API_ definition. This can be used to imp
5050

5151
Features can be used in combination with _API_ and add more functionality on top, like simulation support (see [olink](olink.md#simulation))
5252

53-
- [olink](olink.md) - provides a client and server adapters for each interface, that can be connected to any of the other technology templates with support for [ObjectLink](/docs/advanced/objectlink/intro). Use this feature to connect with ApiGear simulation tools.
53+
- [olink](olink.md) - provides a client and server adapters for each interface, that can be connected to any of the other technology templates with support for [ObjectLink](/docs/advanced/protocols/objectlink/intro). Use this feature to connect with ApiGear simulation tools.
5454
- examples_olink - examples of generated code for the olink feature. Contains:
5555
- `olinkserver` shows use of your interfaces as an olink services.
5656
- `olinkclient` shows use of your interfaces as an olink clients.
57-
- [monitor](monitor.md) - generates a middle-ware layer which logs all API events to the [CLI](/docs/cli/intro) or the [Studio](/docs/studio/intro)
57+
- [monitor](monitor.md) - generates a middle-ware layer which logs all API events to the [CLI](/docs/tools/cli/intro) or the [Studio](/docs/tools/studio/intro)
5858
- [MQTT](mqtt.md) _experimental_ - provides minimal working adapters for MQTT client and service side for each interfaces. Check also MQTT in other technology templates that supports it.
5959
- examples_mqtt - examples of generated code for the olink feature. Contains:
6060
- `mqttserver` shows use of your interfaces with mqtt adapted for your services.

docs/docs/features/monitor.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ import helloWorldModuleComponent from '!!raw-loader!./data/helloworld.module.yam
77

88
# Monitor
99

10-
Use the monitor feature to examine the interface calls, state and signals during runtime. With this feature you obtain a monitor client and a monitored version of your interfaces. The monitoring server is embedded into the [ApiGear Studio](/docs/studio/intro) and [CLI version](/docs/cli/intro).
10+
Use the monitor feature to examine the interface calls, state and signals during runtime. With this feature you obtain a monitor client and a monitored version of your interfaces. The monitoring server is embedded into the [ApiGear Studio](/docs/tools/studio/intro) and [CLI version](/docs/tools/cli/intro).
1111
More details on [monitoring](/docs/advanced/monitor/intro)
1212

1313
## File overview for module

docs/docs/features/olink.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ import Figure from '../figure'
1313

1414
# Olink
1515

16-
This feature provides a _client_ and a _server_ adapter for your interfaces for the [ObjectLink](/docs/advanced/objectlink/intro) protocol. It allows you to connect different applications using the same or different technologies (check all of our [templates](/docs/sdk/intro)).
16+
This feature provides a _client_ and a _server_ adapter for your interfaces for the [ObjectLink](/docs/advanced/protocols/objectlink/intro) protocol. It allows you to connect different applications using the same or different technologies (check all of our [templates](/docs/sdk/intro)).
1717

1818
Use an _OLink client_ instead of your interface implementation to connect to a remote service, or to a the [ApiGear simulation](olink#simulation). Use an _OLink server adapter_ to expose your interface implementation as a remote service.
1919

@@ -26,7 +26,7 @@ If you want quickly start working with them go to use sections of [client](olink
2626

2727
### Apigear ObjectLink protocol and ObjectLink core library
2828

29-
The [ObjectLink](/docs/advanced/objectlink/intro) protocol is a lightweight websocket based protocol for Objects described with an interface. It allows connecting a client object with a server object, and perform remote operations like: remote property change request (client) or notifications on property changed (server), inform about signal emission (server) and allows requesting a remote method call (client) and delivering a response to the caller (server).
29+
The [ObjectLink](/docs/advanced/protocols/objectlink/intro) protocol is a lightweight websocket based protocol for Objects described with an interface. It allows connecting a client object with a server object, and perform remote operations like: remote property change request (client) or notifications on property changed (server), inform about signal emission (server) and allows requesting a remote method call (client) and delivering a response to the caller (server).
3030

3131
The Olink feature for your interface uses a library [ObjectLink core](https://github.com/apigear-io/objectlink-core-cpp), common for cpp based templates. The provided `CMakeLists` already contain all the dependencies, so you don't have to add it manually.
3232

@@ -171,7 +171,7 @@ client.unlinkObjectSource(ioWorldHello->olinkObjectName());
171171
172172
Files `📜helloservice.h` and `📜helloservice.h` contain the olink server adapter for the `Hello` interface - the `HelloService` class.
173173
174-
It implements an `IObjectSource` interface (from [ObjectLink core](https://github.com/apigear-io/objectlink-core-cpp)), which wraps your `Hello` and exposes it for remote usage with the [ObjectLink](/docs/advanced/objectlink/intro) protocol. It handles all the network requests, and calls your local object.
174+
It implements an `IObjectSource` interface (from [ObjectLink core](https://github.com/apigear-io/objectlink-core-cpp)), which wraps your `Hello` and exposes it for remote usage with the [ObjectLink](/docs/advanced/protocols/objectlink/intro) protocol. It handles all the network requests, and calls your local object.
175175
176176
When creating the `HelloService` you need to provide the local `IHello` service object, you want to expose to clients.
177177
@@ -232,7 +232,7 @@ registry.removeSource(ioWorldOlinkHelloService->olinkObjectName());
232232
## Simulation
233233

234234
The simulation can be used to test, demonstrate or develop applications without the need to have the actual service available.
235-
The simulation server is integrated into the [ApiGear studio](/docs/studio/intro) and the [CLI](/docs/cli/simulate).
235+
The simulation server is integrated into the [ApiGear studio](/docs/tools/studio/intro) and the [CLI](/docs/tools/cli/simulate).
236236

237237
For simulating you will use [simulation scenarios](/docs/advanced/simulation/scenario) They allow to define sequences of actions. The actions can change the property values of the service or emit signals. The scenarios can be written using a YAML schema.
238238

docs/docs/intro.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,5 +8,5 @@ This is the documentation for the _cpp14_ template for the [ApiGear](/docs/guide
88

99
It is split in several parts:
1010

11-
- [Quick-Start](quickstart/index.md) is the easiest way to get started
11+
- [Quick-Start](quickstart/index.md?current-template=template-cpp14) is the easiest way to get started
1212
- [Features](features/features.md) explains the available code generator features and their usage and purpose.

0 commit comments

Comments
 (0)