Commit 698a6db8 authored by Tobias Winchen's avatar Tobias Winchen
Browse files

Fix @detail -> @details doygen header

parent 851a73bb
......@@ -69,7 +69,7 @@ class DadaDB
/**
* @brief Return the hexidecimal shared memory key
*
* @detail This key can be used by other processes to access
* @details This key can be used by other processes to access
* the shared memory blocks.
*
* @note This key is the key to the data blocks. To access
......
......@@ -33,7 +33,7 @@ namespace psrdada_cpp {
/**
* @brief Get the next header block in the ring buffer
*
* @detail As only one block can be open at a time, release() must
* @details As only one block can be open at a time, release() must
* be called between subsequenct next() calls.
*
* @return A RawBytes instance wrapping a pointer to share memory
......@@ -43,7 +43,7 @@ namespace psrdada_cpp {
/**
* @brief Release the current data block.
*
* @detail This will mark the block as cleared, making it
* @details This will mark the block as cleared, making it
* writeable by writing client.
*/
void release();
......@@ -56,7 +56,7 @@ namespace psrdada_cpp {
/**
* @brief Realease all full header blocks in the buffer
*
* @detail This method checks the number of full header
* @details This method checks the number of full header
* blocks then calls next() release() that number
* of times.
*/
......@@ -83,7 +83,7 @@ namespace psrdada_cpp {
/**
* @brief Get the next data block in the ring buffer
*
* @detail As only one block can be open at a time, release() must
* @details As only one block can be open at a time, release() must
* be called between subsequenct next() calls.
*
* @return A RawBytes instance wrapping a pointer to share memory
......@@ -93,7 +93,7 @@ namespace psrdada_cpp {
/**
* @brief Release the current data block.
*
* @detail This will mark the block as cleared, making it
* @details This will mark the block as cleared, making it
* writeable by writing client.
*/
void release();
......@@ -111,7 +111,7 @@ namespace psrdada_cpp {
/**
* @brief Realease all full data blocks in the buffer
*
* @detail This method checks the number of full data
* @details This method checks the number of full data
* blocks then calls next() release() that number
* of times.
*/
......
......@@ -38,7 +38,7 @@ namespace psrdada_cpp {
/**
* @brief Get the next header block in the ring buffer
*
* @detail As only one block can be open at a time, release() must
* @details As only one block can be open at a time, release() must
* be called between subsequenct next() calls.
*
* @return A RawBytes instance wrapping a pointer to share memory
......@@ -48,7 +48,7 @@ namespace psrdada_cpp {
/**
* @brief Release the current header block.
*
* @detail This will mark the block as filled, making it
* @details This will mark the block as filled, making it
* readable by reading client.
*/
void release();
......@@ -74,7 +74,7 @@ namespace psrdada_cpp {
/**
* @brief Get the next data block in the ring buffer
*
* @detail As only one block can be open at a time, release() must
* @details As only one block can be open at a time, release() must
* be called between subsequenct next() calls.
*
* @return A RawBytes instance wrapping a pointer to share memory
......@@ -84,7 +84,7 @@ namespace psrdada_cpp {
/**
* @brief Release the current data block.
*
* @detail This will mark the block as filled, making it
* @details This will mark the block as filled, making it
* readable by reading client.
*/
void release(bool eod=false);
......
......@@ -8,7 +8,7 @@ namespace psrdada_cpp {
*
* @tparam T The internal data type for the buffers
*
* @detail An implementation of the double buffer concept
* @details An implementation of the double buffer concept
* using thrust::device_vector. Provides double
* buffers in GPU memory.
*
......
......@@ -19,7 +19,7 @@ public:
* @brief A callback to be called on connection
* to a ring buffer.
*
* @detail The first available header block in the
* @details The first available header block in the
* in the ring buffer is provided as an argument.
* It is here that header parameters could be read
* if desired.
......
......@@ -19,7 +19,7 @@ public:
* @brief A callback to be called on connection
* to a ring buffer.
*
* @detail The first available header block in the
* @details The first available header block in the
* in the ring buffer is provided as an argument.
* It is here that header parameters could be read
* if desired.
......
......@@ -19,7 +19,7 @@ public:
* @brief A callback to be called on connection
* to a ring buffer.
*
* @detail The first available header block in the
* @details The first available header block in the
* in the ring buffer is provided as an argument.
* It is here that header parameters could be read
* if desired.
......
......@@ -38,7 +38,7 @@ public:
* @brief A callback to be called on connection
* to a ring buffer.
*
* @detail The first available header block in the
* @details The first available header block in the
* in the ring buffer is provided as an argument.
* It is here that header parameters could be read
* if desired.
......
......@@ -301,7 +301,7 @@ public:
* @brief A callback to be called on connection
* to a ring buffer.
*
* @detail The first available header block in the
* @details The first available header block in the
* in the ring buffer is provided as an argument.
* It is here that header parameters could be read
* if desired.
......@@ -370,7 +370,7 @@ private:
/**
* @brief Splits the input data depending on a bit set into two arrays.
*
* @detail The resulting gaps are filled with zeros in the other stream.
* @details The resulting gaps are filled with zeros in the other stream.
*
* @param GO Input data. Data is set to the baseline value if corresponding
* sideChannelData bit at bitpos os set.
......
......@@ -78,7 +78,7 @@ public:
* @brief A callback to be called on connection
* to a ring buffer.
*
* @detail The first available header block in the
* @details The first available header block in the
* in the ring buffer is provided as an argument.
* It is here that header parameters could be read
* if desired.
......@@ -145,7 +145,7 @@ private:
/**
* @brief Splits the input data depending on a bit set into two arrays.
*
* @detail The resulting gaps are filled with a given baseline value in the other stream.
* @details The resulting gaps are filled with a given baseline value in the other stream.
*
* @param GO Input data. Data is set to the baseline value if corresponding
* sideChannelData bit at bitpos os set.
......
......@@ -14,7 +14,7 @@ namespace edd {
/**
* @brief Sums all elements of an input array.
*
* @detail The results is stored in an array with one value per launch
* @details The results is stored in an array with one value per launch
* block. Full reduction thus requires two kernel launches.
*
* @param in. Input array.
......@@ -24,7 +24,7 @@ namespace edd {
__global__ void array_sum(float *in, size_t N, float *out);
/// Calculates 1/N \sum (x_i - 1/N offset)**2 per block
/// Calculates \f$ 1/N \sum (x_i - 1/N offset)**2 \f$ per block
/// To calculate the std dev sum partial results of block using array sum
__global__ void scaled_square_residual_sum(float *in, size_t N, float* offset, float *out);
......
......@@ -116,7 +116,7 @@ public:
* @brief A callback to be called on connection
* to a ring buffer.
*
* @detail The first available header block in the
* @details The first available header block in the
* in the ring buffer is provided as an argument.
* It is here that header parameters could be read
* if desired.
......
......@@ -60,7 +60,7 @@ class VDIF_Sender
* @brief A callback to be called on connection
* to a ring buffer.
*
* @detail The first available header block in the
* @details The first available header block in the
* in the ring buffer is provided as an argument.
* It is here that header parameters could be read
* if desired.
......
......@@ -35,7 +35,7 @@ public:
/**
* @brief generates test vector
*
* @detail The test vector is a normal distribution vector and contains RFI if the flag with_rfi is set to true.
* @details The test vector is a normal distribution vector and contains RFI if the flag with_rfi is set to true.
*
* @param rfi_windows vector of window indices on which the RFI has to be added.
* test_samples output test vector
......
......@@ -17,7 +17,7 @@ namespace rfi_chamber {
* @brief Pipeline for processing single polarisation channelised
* data in TF order.
*
* @detail Pipeline has been developed to handle the output of an FPGA
* @details Pipeline has been developed to handle the output of an FPGA
* attached to a Rohde & Schwarz spectrum analyser running in
* IQ sampling mode.
*
......@@ -59,7 +59,7 @@ public:
*
* @param header The header in DADA format
*
* @detail Currently a NO-OP, as no information is required from the header.
* @details Currently a NO-OP, as no information is required from the header.
*/
void init(RawBytes &header);
......
......@@ -4,7 +4,7 @@
#include <cstdlib>
#include "psrdada_cpp/raw_bytes.hpp"
/**
* @detail: A simple file input stream. Will go through one entire file.
* @details A simple file input stream. Will go through one entire file.
* Will assume there is some amount of header to the file.
*/
......
......@@ -39,7 +39,7 @@ struct char2x4
* @param[in] a An integer composed of 4 chars
* @param[in] b An integer composed of 4 chars
*
* @detail If we treat a and b like to char4 instances, then the dp4a
* @details If we treat a and b like to char4 instances, then the dp4a
* instruction performs the following:
*
* c = (a.x * b.x) + (a.y * b.y) + (a.z * b.z) + (a.w * b.w)
......
......@@ -28,7 +28,7 @@ public:
*
* @param config The pipeline configuration.
*
* @detail The passed pipeline configuration contains the names
* @details The passed pipeline configuration contains the names
* of the POSIX shm and sem to connect to for the delay
* models.
*/
......@@ -39,7 +39,7 @@ public:
/**
* @brief Get the current delay model
*
* @detail On a call to this function, a check is made on the
* @details On a call to this function, a check is made on the
* delays counting semaphore to see if a delay model
* update is available. If so, the values are retrieved
* from shared memory and copied to the GPU. This function
......
......@@ -12,7 +12,7 @@ namespace fbfuse {
/**
* @brief A helper class for managing DADA headers
*
* @detail DADA headers are composed of ASCII key-value
* @details DADA headers are composed of ASCII key-value
* pairs stored in a single char array.
*/
class Header
......
......@@ -34,7 +34,7 @@ public:
* @brief Get the key to POSIX mutex
* for the delay buffer.
*
* @detail This mutex is used to prevent clients
* @details This mutex is used to prevent clients
* from reading the delay buffer during
* and update.
*/
......@@ -44,7 +44,7 @@ public:
* @brief Set the key to POSIX mutex
* for the delay buffer.
*
* @detail This mutex is used to prevent clients
* @details This mutex is used to prevent clients
* from reading the delay buffer during
* and update.
*/
......@@ -54,7 +54,7 @@ public:
* @brief Get the key to POSIX semaphore
* for the delay buffer.
*
* @detail This is a counting semaphore that
* @details This is a counting semaphore that
* is updated whenever a new delay
* model becomes available.
*/
......@@ -64,7 +64,7 @@ public:
* @brief Set the key to POSIX semaphore
* for the delay buffer.
*
* @detail This is a counting semaphore that
* @details This is a counting semaphore that
* is updated whenever a new delay
* model becomes available.
*/
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment