1
0
Fork 0
mirror of https://git.rwth-aachen.de/acs/public/villas/node/ synced 2025-03-09 00:00:00 +01:00

Remove more Doxygen-style comments

Signed-off-by: Steffen Vogel <post@steffenvogel.de>
This commit is contained in:
Steffen Vogel 2023-09-04 18:16:15 +02:00
parent b5f554d828
commit bbb3cfe240
21 changed files with 28 additions and 34 deletions

View file

@ -12,7 +12,7 @@
// The current version number for the message format
#define MSG_VERSION 2
// @todo Implement more message types
// TODO: Implement more message types
#define MSG_TYPE_DATA 0 // Message contains float values
#define MSG_TYPE_START 1 // Message marks the beginning of a new simulation case
#define MSG_TYPE_STOP 2 // Message marks the end of a simulation case
@ -41,10 +41,7 @@
.tv_nsec = (msg)->ts.nsec \
}
/* This message format is used by all clients
*
* @diafile msg_format.dia
*/
// This message format is used by all clients
struct msg
{
#if BYTE_ORDER == BIG_ENDIAN

View file

@ -12,7 +12,7 @@
// The current version number for the message format
#define MSG_VERSION 2
// @todo Implement more message types
// TODO: Implement more message types
#define MSG_TYPE_DATA 0 // Message contains float / integer values
#define MSG_TYPE_START 1 // Message marks the beginning of a new simulation case
#define MSG_TYPE_STOP 2 // Message marks the end of a simulation case
@ -34,10 +34,7 @@
namespace villas {
namespace node {
/* This message format is used by all clients
*
* @diafile msg_format.dia
*/
// This message format is used by all clients
struct Message
{
#if BYTE_ORDER == BIG_ENDIAN

View file

@ -30,7 +30,7 @@ struct Block {
bool used;
};
// @todo Unused for now
// TODO: Unused for now
struct Allocation {
struct Type *type;

View file

@ -25,7 +25,7 @@
#define ETHERCAT_PID_EL3008 0x0bc03052
#define ETHERCAT_PID_FC1100 0x044c0c62
// @todo Make PDO entry tables configurable
// TODO: Make PDO entry tables configurable
/* Master 0, Slave 3, "EL4038"
* Vendor ID: 0x00000002

View file

@ -70,7 +70,7 @@ struct CQueue {
std::atomic<size_t> head; // Queue head pointer
cacheline_pad_t _pad3; // @todo Why needed?
cacheline_pad_t _pad3; // TODO: Why needed?
};
// Initialize MPMC queue

View file

@ -57,7 +57,7 @@ char * socket_print_addr(struct sockaddr *saddr);
* A IPv4 address has the follwing format: [hostname/ip]:[port/protocol]
* A link layer address has the following format: [mac]%[interface]:[ethertype]
*
* @todo Add support for autodetection of address type
* TODO: Add support for autodetection of address type
*
* @param str A string specifiying the socket address. See description for allowed formats.
* @param sa A pointer to the resolved address

View file

@ -13,7 +13,7 @@
typedef float flt32_t;
typedef double flt64_t;
typedef long double flt128_t; // @todo check
typedef long double flt128_t; // TODO: check
using namespace villas;
using namespace villas::node;

View file

@ -36,7 +36,7 @@ int VillasBinaryFormat::sprint(char *buf, size_t len, size_t *wbytes, const stru
return ret;
if (web) {
// @todo convert to little endian
// TODO: convert to little endian
}
else
msg_hton(msg);
@ -81,7 +81,7 @@ int VillasBinaryFormat::sscan(const char *buf, size_t len, size_t *rbytes, struc
return -3; // Invalid msg receive
if (web) {
// @todo convert from little endian
// TODO: convert from little endian
}
else
msg_ntoh(msg);

View file

@ -106,7 +106,7 @@ public:
if (maxBin == 0 || maxBin == (frequencyCount - 1)) {
logger->warn("Maximum frequency bin lies on window boundary. Using non-estimated results!");
//@todo add handling to not forward this phasor!!
//TODO: add handling to not forward this phasor!!
} else {
const double startFrequency = nominalFreq - estimationRange;
const double frequencyResolution = (double)sampleRate / windowSize;

View file

@ -315,7 +315,7 @@ int comedi_start_out(NodeCompat *n)
d->last_debug = time_now();
// Allocate buffer for one complete VILLAS sample
// @todo maybe increase buffer size according to c->vectorize
// TODO: maybe increase buffer size according to c->vectorize
const size_t local_buffer_size = d->sample_size * d->chanlist_len;
d->buffer = new char[local_buffer_size];
d->bufptr = d->buffer;
@ -448,7 +448,7 @@ int villas::node::comedi_start(NodeCompat *n)
throw RuntimeError("Failed to open device: {}", comedi_strerror(comedi_errno()));
// Enable non-blocking syscalls
// @todo verify if this works with both input and output, so comment out
// TODO: verify if this works with both input and output, so comment out
//if (fcntl(comedi_fileno(c->dev), F_SETFL, O_NONBLOCK))
// throw RuntimeError("Failed to set non-blocking flag in Comedi FD");
@ -595,7 +595,7 @@ int villas::node::comedi_read(NodeCompat *n, struct Sample * const smps[], unsig
const size_t bytes_left = bytes_available - bytes_consumed;
if (bytes_left > 0) {
// Move leftover bytes to the beginning of buffer
// @todo optimize?
// TODO: optimize?
memmove(c->buf, c->bufptr, bytes_left);
}

View file

@ -294,7 +294,7 @@ int villas::node::ethercat_start(NodeCompat *n)
if (ret)
throw RuntimeError("PDO entry registration failed!");
// @todo Check that master is not already active...
// TODO: Check that master is not already active...
ret = ecrt_master_activate(master);
if (ret)
return -1;
@ -420,7 +420,7 @@ int villas::node::ethercat_destroy(NodeCompat *n)
w->task.~Task();
// @todo Destroy domain?
// TODO: Destroy domain?
return 0;
}

View file

@ -156,7 +156,7 @@ int ExecNode::stop()
logger->debug("Waiting for sub-process with pid={} to terminate", proc->getPid());
proc->close();
// @todo Check exit code of subprocess?
// TODO: Check exit code of subprocess?
return 0;
}

View file

@ -431,7 +431,7 @@ int villas::node::file_poll_fds(NodeCompat *n, int fds[])
return 1;
}
return -1; // @todo not supported yet
return -1; // TODO: not supported yet
}
int villas::node::file_init(NodeCompat *n)

View file

@ -221,7 +221,7 @@ char * villas::node::opal_print(NodeCompat *n)
{
auto *o = n->getData<struct opal>();
// @todo Print send_params, recv_params
// TODO: Print send_params, recv_params
return strf("sendID=%u, recvID=%u, reply=%u",
o->sendID, o->recvID, o->reply);
@ -275,7 +275,7 @@ int villas::node::opal_read(NodeCompat *n, struct Sample * const smps[], unsigne
if ((state == STATE_RESET) || (state == STATE_STOP))
throw RuntimeError("OpalGetAsyncModelState(): Model stopped or resetted!");
return -1; // @todo correct return value
return -1; // TODO: correct return value
}
} while (id != o->sendID);

View file

@ -209,7 +209,7 @@ int villas::node::rtp_parse(NodeCompat *n, json_t *json)
sa_set_port(&r->in.saddr_rtp, port);
sa_set_port(&r->in.saddr_rtcp, port+1);
/* @todo parse * in addresses */
/* TODO: parse * in addresses */
return 0;
}

View file

@ -163,7 +163,7 @@ int villas::node::shmem_read(NodeCompat *n, struct Sample * const smps[], unsign
sample_copy_many(smps, shared_smps, recv);
sample_decref_many(shared_smps, recv);
// @todo signal descriptions are currently not shared between processes
// TODO: signal descriptions are currently not shared between processes
for (int i = 0; i < recv; i++)
smps[i]->signals = n->getInputSignals(false);

View file

@ -554,7 +554,7 @@ int villas::node::uldaq_stop(NodeCompat *n)
UlError err;
// @todo Fix deadlock
// TODO: Fix deadlock
//pthread_mutex_lock(&u->in.mutex);
// Get the current status of the acquisition

View file

@ -232,7 +232,7 @@ int villas::node::websocket_protocol_cb(struct lws *wsi, enum lws_callback_reaso
c->node->logger->debug("Closed WebSocket connection: {}", c->toString());
if (c->state != websocket_connection::State::CLOSING) {
// @todo Attempt reconnect here
// TODO: Attempt reconnect here
}
{

View file

@ -217,7 +217,7 @@ int villas::node::zeromq_parse(NodeCompat *n, json_t *json)
memcpy(z->curve.server.secret_key, secret_key, 41);
}
// @todo We should fix this. Its mostly done.
// TODO: We should fix this. Its mostly done.
if (z->curve.enabled)
throw ConfigError(json_curve, "node-config-zeromq-curve", "CurveZMQ support is currently broken");

View file

@ -80,7 +80,7 @@ char * villas::node::socket_print_addr(struct sockaddr *saddr)
int villas::node::socket_parse_address(const char *addr, struct sockaddr *saddr, enum SocketLayer layer, int flags)
{
// @todo Add support for IPv6
// TODO: Add support for IPv6
union sockaddr_union *sa = (union sockaddr_union *) saddr;
char *copy = strdup(addr);

View file

@ -69,7 +69,7 @@ void fill_sample_data(SignalList::Ptr signals, struct Sample *smps[], unsigned c
break;
case SignalType::COMPLEX: {
// @todo Port to proper C++
// TODO: Port to proper C++
std::complex<float> z = { j * 0.1f, i * 100.0f };
memcpy(&data->z, &z, sizeof(data->z));
break;