mirror of
https://git.rwth-aachen.de/acs/public/villas/node/
synced 2025-03-09 00:00:00 +01:00
Harmonize descriptions of plugins
Signed-off-by: Steffen Vogel <post@steffenvogel.de>
This commit is contained in:
parent
6c5e29de68
commit
3326499e19
20 changed files with 20 additions and 20 deletions
|
@ -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 {
|
||||
|
|
|
@ -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";
|
||||
}
|
||||
};
|
||||
|
||||
|
|
|
@ -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
|
||||
|
|
|
@ -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
|
||||
|
|
|
@ -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
|
||||
|
|
|
@ -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
|
||||
|
|
|
@ -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
|
||||
|
|
|
@ -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
|
||||
|
|
|
@ -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
|
||||
|
|
|
@ -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
|
||||
|
|
|
@ -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
|
||||
|
|
|
@ -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
|
||||
|
|
|
@ -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
|
||||
|
|
|
@ -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
|
||||
|
|
|
@ -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
|
||||
|
|
|
@ -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
|
||||
|
|
|
@ -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
|
||||
|
|
|
@ -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
|
||||
|
|
|
@ -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 |
|
||||
|
|
|
@ -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 |
|
||||
|
|
Loading…
Add table
Reference in a new issue