Mirrors/VILLASnode
1
0
Fork 0
mirror of https://git.rwth-aachen.de/acs/public/villas/node/ synced 2025-03-09 00:00:00 +01:00
Code Issues Releases Wiki Activity

Harmonize descriptions of plugins

Browse source 
Signed-off-by: Steffen Vogel <post@steffenvogel.de>
This commit is contained in:
Steffen Vogel 2024-04-10 08:50:58 +02:00 • committed by pipeacosta
parent 6c5e29de68
commit 3326499e19
20 changed files with 20 additions and 20 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
fpga/include/villas/fpga/ips/i2c.hpp
View file

@ -106,7 +106,7 @@ class I2cFactory : NodeFactory {
public:
virtual std::string getName() const { return "i2c"; }
virtual std::string getDescription() const { return "Xilinx's AXI4 iic IP"; }
virtual std::string getDescription() const { return "Xilinx's AXI4 IIC IP"; }
private:
virtual Vlnv getCompatibleVlnv() const {

2
include/villas/nodes/loopback_internal.hpp
View file

@ -56,7 +56,7 @@ public:
virtual std::string getName() const { return "loopback.internal"; }
virtual std::string getDescription() const {
return "internal loopback node";
return "Internal loopback node";
}
};

2
lib/api/requests/config.cpp
View file

@ -37,7 +37,7 @@ public:
// Register API request
static char n[] = "config";
static char r[] = "/config";
static char d[] = "get configuration of this VILLASnode instance";
static char d[] = "Get the configuration of this VILLASnode instance";
static RequestPlugin<ConfigRequest, n, r, d> p;
} // namespace api

2
lib/api/requests/graph.cpp
View file

@ -109,7 +109,7 @@ public:
// Register API request
static char n[] = "graph";
static char r[] = "/graph\\.([a-z]+)";
static char d[] = "get graph representation of configuration";
static char d[] = "Get graph representation of configuration";
static RequestPlugin<GraphRequest, n, r, d> p;
} // namespace api

2
lib/api/requests/node_file.cpp
View file

@ -49,7 +49,7 @@ public:
// Register API request
static char n[] = "node/file";
static char r[] = "/node/(" RE_NODE_NAME "|" RE_UUID ")/file(?:/([^/]+))?";
static char d[] = "control instances of 'file' node-type";
static char d[] = "Control instances of 'file' node-type";
static RequestPlugin<FileRequest, n, r, d> p;
} // namespace api

2
lib/api/requests/node_info.cpp
View file

@ -47,7 +47,7 @@ public:
// Register API request
static char n[] = "node";
static char r[] = "/node/(" RE_NODE_NAME "|" RE_UUID ")";
static char d[] = "retrieve info of a node";
static char d[] = "Get node details";
static RequestPlugin<NodeInfoRequest, n, r, d> p;
} // namespace api

2
lib/api/requests/node_stats.cpp
View file

@ -44,7 +44,7 @@ public:
// Register API requests
static char n[] = "node/stats";
static char r[] = "/node/(" RE_NODE_NAME "|" RE_UUID ")/stats";
static char d[] = "get internal statistics counters";
static char d[] = "Get internal statistics counters";
static RequestPlugin<StatsRequest, n, r, d> p;
} // namespace api

2
lib/api/requests/node_stats_reset.cpp
View file

@ -45,7 +45,7 @@ public:
// Register API requests
static char n[] = "node/stats/reset";
static char r[] = "/node/(" RE_NODE_NAME "|" RE_UUID ")/stats/reset";
static char d[] = "reset internal statistics counters";
static char d[] = "Reset internal statistics counters";
static RequestPlugin<StatsRequest, n, r, d> p;
} // namespace api

2
lib/api/requests/nodes.cpp
View file

@ -40,7 +40,7 @@ public:
// Register API request
static char n[] = "nodes";
static char r[] = "/nodes";
static char d[] = "retrieve list of all known nodes";
static char d[] = "Get list of all known nodes";
static RequestPlugin<NodesRequest, n, r, d> p;
} // namespace api

2
lib/api/requests/path_info.cpp
View file

@ -38,7 +38,7 @@ public:
// Register API request
static char n[] = "path";
static char r[] = "/path/(" RE_UUID ")";
static char d[] = "retrieve info of a path";
static char d[] = "Get path details";
static RequestPlugin<PathInfoRequest, n, r, d> p;
} // namespace api

2
lib/api/requests/paths.cpp
View file

@ -40,7 +40,7 @@ public:
// Register API request
static char n[] = "paths";
static char r[] = "/paths";
static char d[] = "retrieve list of all paths with details";
static char d[] = "Get list of all paths with details";
static RequestPlugin<PathsRequest, n, r, d> p;
} // namespace api

2
lib/api/requests/restart.cpp
View file

@ -113,7 +113,7 @@ std::string RestartRequest::configUri;
// Register API request
static char n[] = "restart";
static char r[] = "/restart";
static char d[] = "restart VILLASnode with new configuration";
static char d[] = "Restart VILLASnode with new configuration";
static RequestPlugin<RestartRequest, n, r, d> p;
} // namespace api

2
lib/api/requests/shutdown.cpp
View file

@ -36,7 +36,7 @@ public:
// Register API request
static char n[] = "shutdown";
static char r[] = "/shutdown";
static char d[] = "quit VILLASnode";
static char d[] = "Terminate VILLASnode instance";
static RequestPlugin<ShutdownRequest, n, r, d> p;
} // namespace api

2
lib/api/requests/status.cpp
View file

@ -99,7 +99,7 @@ public:
// Register API request
static char n[] = "status";
static char r[] = "/status";
static char d[] = "get status and statistics of web server";
static char d[] = "Get status and statistics of web server";
static RequestPlugin<StatusRequest, n, r, d> p;
} // namespace api

2
lib/api/requests/universal/channel.cpp
View file

@ -147,7 +147,7 @@ public:
static char n[] = "universal/channel/sample";
static char r[] =
"/universal/(" RE_NODE_NAME ")/channel/([a-z0-9_-]+)/(sample|event)";
static char d[] = "retrieve or send samples via universal data-exchange API";
static char d[] = "Retrieve or send samples via universal data-exchange API";
static RequestPlugin<ChannelRequest, n, r, d> p;
} // namespace universal

2
lib/api/requests/universal/channels.cpp
View file

@ -54,7 +54,7 @@ public:
// Register API requests
static char n[] = "universal/channels";
static char r[] = "/universal/(" RE_NODE_NAME ")/channels";
static char d[] = "get channels of universal data-exchange API node";
static char d[] = "Get channels of universal data-exchange API node";
static RequestPlugin<SignalsRequest, n, r, d> p;
} // namespace universal

2
lib/api/requests/universal/info.cpp
View file

@ -40,7 +40,7 @@ public:
// Register API requests
static char n[] = "universal/info";
static char r[] = "/universal/(" RE_NODE_NAME ")/info";
static char d[] = "get infos of universal data-exchange API";
static char d[] = "Get details of universal data-exchange API";
static RequestPlugin<InfoRequest, n, r, d> p;
} // namespace universal

2
lib/api/requests/universal/status.cpp
View file

@ -37,7 +37,7 @@ public:
// Register API requests
static char n[] = "universal/status";
static char r[] = "/universal/(" RE_NODE_NAME ")/status";
static char d[] = "get status of universal data-exchange API";
static char d[] = "Get status of universal data-exchange API";
static RequestPlugin<StatusRequest, n, r, d> p;
} // namespace universal

2
lib/nodes/exec.cpp
View file

@ -201,7 +201,7 @@ std::vector<int> ExecNode::getPollFDs() { return {proc->getFdIn()}; }
// Register node
static char n[] = "exec";
static char d[] = "run subprocesses with stdin/stdout communication";
static char d[] = "Run subprocesses with stdin/stdout communication";
static NodePlugin<ExecNode, n, d,
(int)NodeFactory::Flags::SUPPORTS_READ |
(int)NodeFactory::Flags::SUPPORTS_WRITE |

2
lib/nodes/loopback.cpp
View file

@ -125,7 +125,7 @@ int LoopbackNode::parse(json_t *json) {
// Register node
static char n[] = "loopback";
static char d[] = "loopback node-type";
static char d[] = "Loopback node-type";
static NodePlugin<LoopbackNode, n, d,
(int)NodeFactory::Flags::SUPPORTS_POLL |
(int)NodeFactory::Flags::SUPPORTS_READ |