From 698a6db80f85674689d5fb2e927a74f3c8577d28 Mon Sep 17 00:00:00 2001
From: Tobias Winchen <tobias.winchen@rwth-aachen.de>
Date: Thu, 19 Nov 2020 20:33:03 +0000
Subject: [PATCH] Fix @detail -> @details doygen header
---
psrdada_cpp/dada_db.hpp | 2 +-
psrdada_cpp/dada_read_client.hpp | 12 ++++++------
psrdada_cpp/dada_write_client.hpp | 8 ++++----
psrdada_cpp/double_buffer.cuh | 2 +-
psrdada_cpp/effelsberg/edd/EDDPolnMerge.hpp | 2 +-
psrdada_cpp/effelsberg/edd/EDDRoach.hpp | 2 +-
psrdada_cpp/effelsberg/edd/EDDRoach_merge.hpp | 2 +-
.../effelsberg/edd/FftSpectrometer.cuh | 2 +-
.../effelsberg/edd/GatedSpectrometer.cuh | 4 ++--
.../edd/GatedStokesSpectrometer.cuh | 4 ++--
psrdada_cpp/effelsberg/edd/Tools.cuh | 4 ++--
psrdada_cpp/effelsberg/edd/VLBI.cuh | 2 +-
psrdada_cpp/effelsberg/edd/src/vdif_send.cu | 2 +-
.../effelsberg/edd/test/SKTestVector.hpp | 2 +-
.../effelsberg/rfi_chamber/RSSpectrometer.cuh | 4 ++--
psrdada_cpp/file_input_stream.hpp | 2 +-
.../meerkat/fbfuse/CoherentBeamformer.cuh | 2 +-
psrdada_cpp/meerkat/fbfuse/DelayManager.cuh | 4 ++--
psrdada_cpp/meerkat/fbfuse/Header.hpp | 2 +-
psrdada_cpp/meerkat/fbfuse/PipelineConfig.hpp | 8 ++++----
psrdada_cpp/meerkat/fbfuse/SplitTranspose.cuh | 2 +-
psrdada_cpp/meerkat/fbfuse/WeightsManager.cuh | 2 +-
.../meerkat/fbfuse/fbfuse_interface.pyc | Bin 42382 -> 42385 bytes
.../meerkat/tools/feng_to_bandpass.cuh | 4 ++--
psrdada_cpp/meerkat/tools/feng_to_dada.cuh | 2 +-
.../meerkat/tuse/transpose_to_dada.hpp | 2 +-
psrdada_cpp/psrdada_to_sigproc_header.hpp | 2 +-
psrdada_cpp/raw_bytes.hpp | 6 +++---
psrdada_cpp/src/dada_db.cpp | 2 +-
29 files changed, 47 insertions(+), 47 deletions(-)
diff --git a/psrdada_cpp/dada_db.hpp b/psrdada_cpp/dada_db.hpp
index 449dbefc..b0e64eda 100644
--- a/psrdada_cpp/dada_db.hpp
+++ b/psrdada_cpp/dada_db.hpp
@@ -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
diff --git a/psrdada_cpp/dada_read_client.hpp b/psrdada_cpp/dada_read_client.hpp
index 633007bf..70346da1 100644
--- a/psrdada_cpp/dada_read_client.hpp
+++ b/psrdada_cpp/dada_read_client.hpp
@@ -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.
*/
diff --git a/psrdada_cpp/dada_write_client.hpp b/psrdada_cpp/dada_write_client.hpp
index 23a47fa3..f608de9f 100644
--- a/psrdada_cpp/dada_write_client.hpp
+++ b/psrdada_cpp/dada_write_client.hpp
@@ -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);
diff --git a/psrdada_cpp/double_buffer.cuh b/psrdada_cpp/double_buffer.cuh
index ef625167..b1991573 100644
--- a/psrdada_cpp/double_buffer.cuh
+++ b/psrdada_cpp/double_buffer.cuh
@@ -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.
*
diff --git a/psrdada_cpp/effelsberg/edd/EDDPolnMerge.hpp b/psrdada_cpp/effelsberg/edd/EDDPolnMerge.hpp
index 87488fb7..4049a257 100644
--- a/psrdada_cpp/effelsberg/edd/EDDPolnMerge.hpp
+++ b/psrdada_cpp/effelsberg/edd/EDDPolnMerge.hpp
@@ -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.
diff --git a/psrdada_cpp/effelsberg/edd/EDDRoach.hpp b/psrdada_cpp/effelsberg/edd/EDDRoach.hpp
index 6343f333..5afced9a 100644
--- a/psrdada_cpp/effelsberg/edd/EDDRoach.hpp
+++ b/psrdada_cpp/effelsberg/edd/EDDRoach.hpp
@@ -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.
diff --git a/psrdada_cpp/effelsberg/edd/EDDRoach_merge.hpp b/psrdada_cpp/effelsberg/edd/EDDRoach_merge.hpp
index 1551b0f5..0e6e89ff 100644
--- a/psrdada_cpp/effelsberg/edd/EDDRoach_merge.hpp
+++ b/psrdada_cpp/effelsberg/edd/EDDRoach_merge.hpp
@@ -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.
diff --git a/psrdada_cpp/effelsberg/edd/FftSpectrometer.cuh b/psrdada_cpp/effelsberg/edd/FftSpectrometer.cuh
index faf162fd..465e33b9 100644
--- a/psrdada_cpp/effelsberg/edd/FftSpectrometer.cuh
+++ b/psrdada_cpp/effelsberg/edd/FftSpectrometer.cuh
@@ -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.
diff --git a/psrdada_cpp/effelsberg/edd/GatedSpectrometer.cuh b/psrdada_cpp/effelsberg/edd/GatedSpectrometer.cuh
index 4b489f4b..827022d6 100644
--- a/psrdada_cpp/effelsberg/edd/GatedSpectrometer.cuh
+++ b/psrdada_cpp/effelsberg/edd/GatedSpectrometer.cuh
@@ -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.
diff --git a/psrdada_cpp/effelsberg/edd/GatedStokesSpectrometer.cuh b/psrdada_cpp/effelsberg/edd/GatedStokesSpectrometer.cuh
index a55790cd..b55cb194 100644
--- a/psrdada_cpp/effelsberg/edd/GatedStokesSpectrometer.cuh
+++ b/psrdada_cpp/effelsberg/edd/GatedStokesSpectrometer.cuh
@@ -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.
diff --git a/psrdada_cpp/effelsberg/edd/Tools.cuh b/psrdada_cpp/effelsberg/edd/Tools.cuh
index d4135964..8e43e460 100644
--- a/psrdada_cpp/effelsberg/edd/Tools.cuh
+++ b/psrdada_cpp/effelsberg/edd/Tools.cuh
@@ -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);
diff --git a/psrdada_cpp/effelsberg/edd/VLBI.cuh b/psrdada_cpp/effelsberg/edd/VLBI.cuh
index 937dcb96..93095eda 100644
--- a/psrdada_cpp/effelsberg/edd/VLBI.cuh
+++ b/psrdada_cpp/effelsberg/edd/VLBI.cuh
@@ -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.
diff --git a/psrdada_cpp/effelsberg/edd/src/vdif_send.cu b/psrdada_cpp/effelsberg/edd/src/vdif_send.cu
index 9f34163a..75564def 100644
--- a/psrdada_cpp/effelsberg/edd/src/vdif_send.cu
+++ b/psrdada_cpp/effelsberg/edd/src/vdif_send.cu
@@ -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.
diff --git a/psrdada_cpp/effelsberg/edd/test/SKTestVector.hpp b/psrdada_cpp/effelsberg/edd/test/SKTestVector.hpp
index b115c722..de88a05a 100644
--- a/psrdada_cpp/effelsberg/edd/test/SKTestVector.hpp
+++ b/psrdada_cpp/effelsberg/edd/test/SKTestVector.hpp
@@ -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
diff --git a/psrdada_cpp/effelsberg/rfi_chamber/RSSpectrometer.cuh b/psrdada_cpp/effelsberg/rfi_chamber/RSSpectrometer.cuh
index 770ceec3..9bc92dea 100644
--- a/psrdada_cpp/effelsberg/rfi_chamber/RSSpectrometer.cuh
+++ b/psrdada_cpp/effelsberg/rfi_chamber/RSSpectrometer.cuh
@@ -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);
diff --git a/psrdada_cpp/file_input_stream.hpp b/psrdada_cpp/file_input_stream.hpp
index bfa81ee3..0beaf446 100644
--- a/psrdada_cpp/file_input_stream.hpp
+++ b/psrdada_cpp/file_input_stream.hpp
@@ -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.
*/
diff --git a/psrdada_cpp/meerkat/fbfuse/CoherentBeamformer.cuh b/psrdada_cpp/meerkat/fbfuse/CoherentBeamformer.cuh
index b537ae57..c52162a4 100644
--- a/psrdada_cpp/meerkat/fbfuse/CoherentBeamformer.cuh
+++ b/psrdada_cpp/meerkat/fbfuse/CoherentBeamformer.cuh
@@ -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)
diff --git a/psrdada_cpp/meerkat/fbfuse/DelayManager.cuh b/psrdada_cpp/meerkat/fbfuse/DelayManager.cuh
index 9371c3b3..289a36cd 100644
--- a/psrdada_cpp/meerkat/fbfuse/DelayManager.cuh
+++ b/psrdada_cpp/meerkat/fbfuse/DelayManager.cuh
@@ -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
diff --git a/psrdada_cpp/meerkat/fbfuse/Header.hpp b/psrdada_cpp/meerkat/fbfuse/Header.hpp
index 2b25630c..54704bc4 100644
--- a/psrdada_cpp/meerkat/fbfuse/Header.hpp
+++ b/psrdada_cpp/meerkat/fbfuse/Header.hpp
@@ -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
diff --git a/psrdada_cpp/meerkat/fbfuse/PipelineConfig.hpp b/psrdada_cpp/meerkat/fbfuse/PipelineConfig.hpp
index 9a99f925..f838a73f 100644
--- a/psrdada_cpp/meerkat/fbfuse/PipelineConfig.hpp
+++ b/psrdada_cpp/meerkat/fbfuse/PipelineConfig.hpp
@@ -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.
*/
diff --git a/psrdada_cpp/meerkat/fbfuse/SplitTranspose.cuh b/psrdada_cpp/meerkat/fbfuse/SplitTranspose.cuh
index 1df564f4..3f5ad218 100644
--- a/psrdada_cpp/meerkat/fbfuse/SplitTranspose.cuh
+++ b/psrdada_cpp/meerkat/fbfuse/SplitTranspose.cuh
@@ -37,7 +37,7 @@ void split_transpose_k(
/**
* @brief Class for split transposing voltate data
*
- * @detail This class wraps a split transpose method that
+ * @details This class wraps a split transpose method that
* is used to convert from the TAFTP order data
* received by FBFUSE into FTPA order data that
* can be most efficiently beamformed. The reason
diff --git a/psrdada_cpp/meerkat/fbfuse/WeightsManager.cuh b/psrdada_cpp/meerkat/fbfuse/WeightsManager.cuh
index 78f861ea..507b564a 100644
--- a/psrdada_cpp/meerkat/fbfuse/WeightsManager.cuh
+++ b/psrdada_cpp/meerkat/fbfuse/WeightsManager.cuh
@@ -53,7 +53,7 @@ public:
*
* @param[in] epoch The epoch at which to evaluate the given delay models
*
- * @detail No check is performed here on whether the provided epoch is in
+ * @details No check is performed here on whether the provided epoch is in
* the bounds of the current delay polynomial. The assumption here
* is the we are running real time and as such there is no large
* latency between the reception of a set of delay models and a
diff --git a/psrdada_cpp/meerkat/fbfuse/fbfuse_interface.pyc b/psrdada_cpp/meerkat/fbfuse/fbfuse_interface.pyc
index 401239ebc61d23354e62696a65642d28993f0682..a8362e313b0fbfa43b4ac5527510b10feaedd660 100644
GIT binary patch
delta 37
scmeA>%{1{e(}p8jEX4{6L6fC*Wj8<3N@Zd!-t4LC!2+Zv8vZQ?00=t`!vFvP
delta 32
ocmbPunyK$J(}p8j%nAxYlVx;eH$T-%W!mhm>%p>lis9d40L&i@ZU6uP
diff --git a/psrdada_cpp/meerkat/tools/feng_to_bandpass.cuh b/psrdada_cpp/meerkat/tools/feng_to_bandpass.cuh
index ee22099c..3ad21436 100644
--- a/psrdada_cpp/meerkat/tools/feng_to_bandpass.cuh
+++ b/psrdada_cpp/meerkat/tools/feng_to_bandpass.cuh
@@ -16,7 +16,7 @@ namespace kernels {
* @brief Convert data that is in MeerKAT F-engine order into
* a spectrum for each antenna
*
- * @detail The heaps from the the MeerKAT F-engine are in in FTP
+ * @details The heaps from the the MeerKAT F-engine are in in FTP
* order with the T = 256 and P = 2. The number of frequency
* channels in a heap is variable but is always a power of two.
* The data itself is 8-bit complex (8-bit real, 8-bit imaginary).
@@ -59,7 +59,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.
diff --git a/psrdada_cpp/meerkat/tools/feng_to_dada.cuh b/psrdada_cpp/meerkat/tools/feng_to_dada.cuh
index 6e1a091b..78e8084e 100644
--- a/psrdada_cpp/meerkat/tools/feng_to_dada.cuh
+++ b/psrdada_cpp/meerkat/tools/feng_to_dada.cuh
@@ -31,7 +31,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.
diff --git a/psrdada_cpp/meerkat/tuse/transpose_to_dada.hpp b/psrdada_cpp/meerkat/tuse/transpose_to_dada.hpp
index ad6a61d2..a816b58f 100644
--- a/psrdada_cpp/meerkat/tuse/transpose_to_dada.hpp
+++ b/psrdada_cpp/meerkat/tuse/transpose_to_dada.hpp
@@ -28,7 +28,7 @@ public:
* @brief A transpose method to be called on connection
* to a ring buffer.
*
- * @detail The number of beams to process and a vector of
+ * @details The number of beams to process and a vector of
* shared pointers to open DADA blocks are given
* as arguments. The transpose is performed on
* a beam to beam basis.
diff --git a/psrdada_cpp/psrdada_to_sigproc_header.hpp b/psrdada_cpp/psrdada_to_sigproc_header.hpp
index 624024b3..804d1cc6 100644
--- a/psrdada_cpp/psrdada_to_sigproc_header.hpp
+++ b/psrdada_cpp/psrdada_to_sigproc_header.hpp
@@ -19,7 +19,7 @@ public:
* @brief A header manipulation method for PSRDADA and SIGPROC
*
*
- * @detail A class that converts the PSRDADA header to a SIGPROC
+ * @details A class that converts the PSRDADA header to a SIGPROC
* header before writing it out to the header block of the
* DADA buffer. This conversion is needed so that the down
* stream pipeline can handle the header format.
diff --git a/psrdada_cpp/raw_bytes.hpp b/psrdada_cpp/raw_bytes.hpp
index 6e12209b..cf4c08af 100644
--- a/psrdada_cpp/raw_bytes.hpp
+++ b/psrdada_cpp/raw_bytes.hpp
@@ -8,7 +8,7 @@ namespace psrdada_cpp {
/**
* @brief Class for wrapping a raw pointer to a buffer of shared memory
*
- * @detail This class is used to wrap pointers to shared memory
+ * @details This class is used to wrap pointers to shared memory
* returned by calls to the lower-level DADA API.
*
* This class is used to wrap buffers acquired by both reading
@@ -31,7 +31,7 @@ namespace psrdada_cpp {
* @param ptr The pointer to the buffer to wrap
* @param[in] total The total number of bytes in the buffer
* @param[in] used The number of bytes currently used in the buffer
- * @oaram[in] device_memory Indicates whether the memory in this buffer resides
+ * @param[in] device_memory Indicates whether the memory in this buffer resides
* on a GPU or not
*/
RawBytes(char* ptr, std::size_t total, std::size_t used=0, bool device_memory=false);
@@ -51,7 +51,7 @@ namespace psrdada_cpp {
/**
* @brief Set the number of currently used bytes in the buffer
*
- * @detail For writing clients, this method should be called after
+ * @details For writing clients, this method should be called after
* all writes are complete so that the number of used_bytes
* can be passed to reading clients.
*/
diff --git a/psrdada_cpp/src/dada_db.cpp b/psrdada_cpp/src/dada_db.cpp
index 399f1512..7a6b3643 100644
--- a/psrdada_cpp/src/dada_db.cpp
+++ b/psrdada_cpp/src/dada_db.cpp
@@ -38,7 +38,7 @@ namespace detail {
/**
* @brief Generate a random shared memory key for use with PSRDADA
*
- * @detail PSRDADA requires two consequtive shared memory keys. We
+ * @details PSRDADA requires two consequtive shared memory keys. We
* first generate an even numbered key of the form 0xdadaXXXX
* where XXXX is a random 16-bit number. This key and the key
* that follows it (i.e. key+1) will be used when allocating a
--
GitLab