Skip to content

Commit 0003dea

Browse files
committed
fix missing documentation in doxygen
1 parent c8d0527 commit 0003dea

File tree

16 files changed

+19
-18
lines changed

16 files changed

+19
-18
lines changed

examples/examples-custom-boards/esp32s3-mic-cam/camera/Camera.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
class Camera;
77

8-
/***
8+
/**
99
* @brief A simple Arduino C++ API over the ESP32 camera functionality.
1010
* @author Phil Schatzmann
1111
*/

src/AudioTools/AudioCodecs/ContainerAVI.h

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,8 @@ enum ParseState {
149149
ParseMovi,
150150
ParseIgnore,
151151
};
152-
/***
152+
153+
/**
153154
* @brief Represents a LIST or a CHUNK: The ParseObject represents the
154155
* current parsing result. We just keep position information and ids
155156
* @author Phil Schatzmann

src/AudioTools/AudioCodecs/MP3Parser.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
namespace audio_tools {
66

7-
/***
7+
/**
88
* @brief Parses MP3 frames, extracts audio info, and outputs complete frames.
99
* The frame duration is determined e.g. for RTSP streaming.
1010
* @ingroup codecs

src/AudioTools/AudioLibs/FFTEffects.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ struct FFTEffectConfig : public AudioInfo {
2020
WindowFunction *window_function = &fft_effects_buffered_window;
2121
};
2222

23-
/***
23+
/**
2424
* @brief Abstract class for common Logic for FFT based effects. The effect is
2525
* applied after the fft to the frequency domain before executing the ifft.
2626
* Please note that this is quite processing time intensitive: so you might keep

src/AudioTools/Communication/AudioPlayer/AudioPlayerProtocol.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
namespace audio_tools {
55

6-
/***
6+
/**
77
* @brief Abstract class for protocol to control the audio player.
88
* @ingroup player
99
* @author Phil Schatzmann

src/AudioTools/Communication/AudioPlayer/AudioPlayerProtocolServer.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
namespace audio_tools {
88

9-
/***
9+
/**
1010
* @brief Audio Player Protocol Server: We can use the indicated protocol over
1111
* http to control the audio player provided by the audiotools.
1212
* @author Phil Schatzmann

src/AudioTools/Communication/HLSStream.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717

1818
namespace audio_tools_hls {
1919

20-
/***
20+
/**
2121
* @brief We feed the URLLoaderHLS with some url strings. The data of the
2222
* related segments are provided via the readBytes() method.
2323
* @author Phil Schatzmann

src/AudioTools/Concurrency/SynchronizedStream.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
namespace audio_tools {
88

9-
/***
9+
/**
1010
* @brief Wrapper class that can turn any Stream into a thread save
1111
* implementation. This is done by adding a Mutex to the Stream. The
1212
* read and write operations are buffered and the access to the stream is

src/AudioTools/CoreAudio/AudioBasic/FloatAudio.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
namespace audio_tools {
55

6-
/***
6+
/**
77
* A simple float number (in the range of -1.0 to 1.0) that supports the conversion to
88
* it's corresponding scaled int values.
99
*/

src/AudioTools/CoreAudio/Buffers.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ class BaseBuffer {
120120
}
121121
};
122122

123-
/***
123+
/**
124124
* @brief A FrameBuffer reads multiple values for array of 2 dimensional frames
125125
*/
126126
template <typename T>
@@ -917,7 +917,7 @@ class NBufferExt : public NBuffer<T> {
917917
using NBuffer<T>::buffer_size;
918918
};
919919

920-
/***
920+
/**
921921
* @brief A File backed buffer which uses the provided files for buffering with
922922
* the indicated max size. A file is made available for reading as soon as it
923923
* reached the size limit. You must provide the files opened in "Write" mode

0 commit comments

Comments
 (0)