From cfddbb033a583d3878563b4d047409cab02432f4 Mon Sep 17 00:00:00 2001 From: Wim Taymans Date: Thu, 13 Feb 2025 21:11:06 +0100 Subject: [PATCH] doc: clarify the port id It might be confused with port.id to state explicitly that this is actually the object.id of a port. --- src/modules/module-link-factory.c | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/src/modules/module-link-factory.c b/src/modules/module-link-factory.c index 6eef97f71..9ff8ac71c 100644 --- a/src/modules/module-link-factory.c +++ b/src/modules/module-link-factory.c @@ -41,20 +41,20 @@ * * ## Properties for the create_object call * - * - `link.output.node`: The output node to use. This can be the node id, node.name, + * - `link.output.node`: The output node to use. This can be the node object.id, node.name, * node.nick, node.description or object.path of a node. When the * property is not given or NULL, the output port should be * specified. - * - `link.output.port`: The output port to link. This can be a port id, port.name, + * - `link.output.port`: The output port to link. This can be a port object.id, port.name, * port.alias or object.path. If an output node is specified, the * port must belong to the node. If no output port is given, an * output node must be specified and a random (unlinked) port will * be used from the node. - * - `link.input.node`: The input node to use. This can be the node id, node.name, + * - `link.input.node`: The input node to use. This can be the node object.id, node.name, * node.nick, node.description or object.path of a node. When the * property is not given or NULL, the input port should be * specified. - * - `link.input.port`: The input port to link. This can be a port id, port.name, + * - `link.input.port`: The input port to link. This can be a port object.id, port.name, * port.alias or object.path. If an input node is specified, the * port must belong to the node. If no input port is given, an * input node must be specified and a random (unlinked) port will