diff --git a/clients/opal/models/send_receive/include/msg_format.h b/clients/opal/models/send_receive/include/msg_format.h index 5a380fcb4..95b7e769f 100644 --- a/clients/opal/models/send_receive/include/msg_format.h +++ b/clients/opal/models/send_receive/include/msg_format.h @@ -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 diff --git a/include/villas/formats/msg_format.hpp b/include/villas/formats/msg_format.hpp index 8e2601271..7512c3e24 100644 --- a/include/villas/formats/msg_format.hpp +++ b/include/villas/formats/msg_format.hpp @@ -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 diff --git a/include/villas/node/memory.hpp b/include/villas/node/memory.hpp index fe9230584..82431c808 100644 --- a/include/villas/node/memory.hpp +++ b/include/villas/node/memory.hpp @@ -30,7 +30,7 @@ struct Block { bool used; }; -// @todo Unused for now +// TODO: Unused for now struct Allocation { struct Type *type; diff --git a/include/villas/nodes/ethercat_config.hpp b/include/villas/nodes/ethercat_config.hpp index 148a8788e..5154574d2 100644 --- a/include/villas/nodes/ethercat_config.hpp +++ b/include/villas/nodes/ethercat_config.hpp @@ -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 diff --git a/include/villas/queue.h b/include/villas/queue.h index 7717c82b0..4b35d5ac0 100644 --- a/include/villas/queue.h +++ b/include/villas/queue.h @@ -70,7 +70,7 @@ struct CQueue { std::atomic head; // Queue head pointer - cacheline_pad_t _pad3; // @todo Why needed? + cacheline_pad_t _pad3; // TODO: Why needed? }; // Initialize MPMC queue diff --git a/include/villas/socket_addr.hpp b/include/villas/socket_addr.hpp index a7f43b99a..07e9de46d 100644 --- a/include/villas/socket_addr.hpp +++ b/include/villas/socket_addr.hpp @@ -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 diff --git a/lib/formats/raw.cpp b/lib/formats/raw.cpp index 34c4f59e2..e429c01d3 100644 --- a/lib/formats/raw.cpp +++ b/lib/formats/raw.cpp @@ -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; diff --git a/lib/formats/villas_binary.cpp b/lib/formats/villas_binary.cpp index f9e1cad5e..87e233704 100644 --- a/lib/formats/villas_binary.cpp +++ b/lib/formats/villas_binary.cpp @@ -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); diff --git a/lib/hooks/pmu_ipdft.cpp b/lib/hooks/pmu_ipdft.cpp index fd5275c4c..3faee9649 100644 --- a/lib/hooks/pmu_ipdft.cpp +++ b/lib/hooks/pmu_ipdft.cpp @@ -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; diff --git a/lib/nodes/comedi.cpp b/lib/nodes/comedi.cpp index 249cfb597..5932a4d17 100644 --- a/lib/nodes/comedi.cpp +++ b/lib/nodes/comedi.cpp @@ -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); } diff --git a/lib/nodes/ethercat.cpp b/lib/nodes/ethercat.cpp index 65d39587a..5c8df874d 100644 --- a/lib/nodes/ethercat.cpp +++ b/lib/nodes/ethercat.cpp @@ -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; } diff --git a/lib/nodes/exec.cpp b/lib/nodes/exec.cpp index ef4269688..3bfa36007 100644 --- a/lib/nodes/exec.cpp +++ b/lib/nodes/exec.cpp @@ -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; } diff --git a/lib/nodes/file.cpp b/lib/nodes/file.cpp index 6dc986ecd..5ae0ea762 100644 --- a/lib/nodes/file.cpp +++ b/lib/nodes/file.cpp @@ -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) diff --git a/lib/nodes/opal.cpp b/lib/nodes/opal.cpp index 9b35895fb..4525ff368 100644 --- a/lib/nodes/opal.cpp +++ b/lib/nodes/opal.cpp @@ -221,7 +221,7 @@ char * villas::node::opal_print(NodeCompat *n) { auto *o = n->getData(); - // @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); diff --git a/lib/nodes/rtp.cpp b/lib/nodes/rtp.cpp index ad64c4f07..f21d19ef4 100644 --- a/lib/nodes/rtp.cpp +++ b/lib/nodes/rtp.cpp @@ -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; } diff --git a/lib/nodes/shmem.cpp b/lib/nodes/shmem.cpp index f2252f8d8..3cbb95270 100644 --- a/lib/nodes/shmem.cpp +++ b/lib/nodes/shmem.cpp @@ -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); diff --git a/lib/nodes/uldaq.cpp b/lib/nodes/uldaq.cpp index f6a907913..f0b9a9916 100644 --- a/lib/nodes/uldaq.cpp +++ b/lib/nodes/uldaq.cpp @@ -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 diff --git a/lib/nodes/websocket.cpp b/lib/nodes/websocket.cpp index f4cc122af..c20516efc 100644 --- a/lib/nodes/websocket.cpp +++ b/lib/nodes/websocket.cpp @@ -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 } { diff --git a/lib/nodes/zeromq.cpp b/lib/nodes/zeromq.cpp index 4d98e199b..216dbc071 100644 --- a/lib/nodes/zeromq.cpp +++ b/lib/nodes/zeromq.cpp @@ -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"); diff --git a/lib/socket_addr.cpp b/lib/socket_addr.cpp index 2fb720ff5..faa5a6d94 100644 --- a/lib/socket_addr.cpp +++ b/lib/socket_addr.cpp @@ -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); diff --git a/tests/unit/format.cpp b/tests/unit/format.cpp index 04c5ecef7..95dbeb2f4 100644 --- a/tests/unit/format.cpp +++ b/tests/unit/format.cpp @@ -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 z = { j * 0.1f, i * 100.0f }; memcpy(&data->z, &z, sizeof(data->z)); break;