Skip to content

Commit 97c54fc

Browse files
committed
Doxygen sorted
1 parent 36a8122 commit 97c54fc

File tree

2 files changed

+13
-13
lines changed

2 files changed

+13
-13
lines changed

Doxyfile

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -649,7 +649,7 @@ SORT_MEMBER_DOCS = YES
649649
# this will also influence the order of the classes in the class list.
650650
# The default value is: NO.
651651

652-
SORT_BRIEF_DOCS = NO
652+
SORT_BRIEF_DOCS = YES
653653

654654
# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
655655
# (brief and detailed) documentation of class members so that constructors and
@@ -661,7 +661,7 @@ SORT_BRIEF_DOCS = NO
661661
# detailed member documentation.
662662
# The default value is: NO.
663663

664-
SORT_MEMBERS_CTORS_1ST = NO
664+
SORT_MEMBERS_CTORS_1ST = YES
665665

666666
# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
667667
# of group names into alphabetical order. If set to NO the group names will

README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -14,24 +14,24 @@ Some basic __header-only C++ classes__ that can be used for __Audio Processing__
1414
- AudioOutputWithCallback class to provide callback integration e.g. with ESP8266Audio
1515

1616
This functionality provides the glue which makes different audio processing components and libraries work together.
17-
We also provide plenty of examples that demonstrate how to implement the different scenarios. The __design philosophy__ is based on the Arduino conventions: we use the ```begin()``` and ```end()``` methods to start and stop the processing and we propagate the __use of Streams__. We all know the Arduino Streams. We use them to write out print messages and sometimes we use them to read the output from Serial devices. The same thing applies to my “Audio Streams”: You can read audio data from “Audio Sources” and you write them to “Audio Sinks”.
17+
We also provide plenty of examples that demonstrate how to implement the different scenarios. The __design philosophy__ is based on the Arduino conventions: we use the ```begin()``` and ```end()``` methods to start and stop the processing and we propagate the __use of Streams__. We all know the Arduino Streams: We use them to write out print messages and sometimes we use them to read the output from Serial devices. The same thing applies to my “Audio Streams”: You can read audio data from “Audio Sources” and you write them to “Audio Sinks”.
1818

1919
As “Audio Sources” we will have e.g.:
2020

21-
- Analog Microphones – AnalogStream
22-
- Digital Microphonse – I2SStream
23-
- Files on the Internet – UrlStream
24-
- Generated Sound – GeneratedSoundStream
25-
- Mobile Phone A2DP Bluetooth – A2DPStream
26-
- Binary Data in Flash Memory – MemoryStream
21+
- Analog Microphones – [AnalogAudio](https://pschatzmann.github.io/arduino-audio-tools/html/classaudio__tools_1_1_analog_audio.html)
22+
- Digital Microphonse – [I2SStream](https://pschatzmann.github.io/arduino-audio-tools/html/classaudio__tools_1_1_i2_s_stream.html)
23+
- Files on the Internet – [UrlStream](https://pschatzmann.github.io/arduino-audio-tools/html/classaudio__tools_1_1_url_stream.html)
24+
- Generated Sound – [GeneratedSoundStream](https://pschatzmann.github.io/arduino-audio-tools/html/classaudio__tools_1_1_generated_sound_stream.html)
25+
- Mobile Phone A2DP Bluetooth – [A2DPStream](https://pschatzmann.github.io/arduino-audio-tools/html/classaudio__tools_1_1_a2_d_p_stream.html)
26+
- Binary Data in Flash Memory – [MemoryStream](https://pschatzmann.github.io/arduino-audio-tools/html/classaudio__tools_1_1_memory_stream.html)
2727
- SD Files
2828

2929
As “Audio Sinks” we will have e.g:
3030

31-
- external DAC – I2SStream
32-
- an Amplifier – AnalogStream
33-
- Bluetooth Speakers – A2DPStream
34-
- Serial to display the data as CSV – CsvStream.
31+
- external DAC – [I2SStream](https://pschatzmann.github.io/arduino-audio-tools/html/classaudio__tools_1_1_i2_s_stream.html)
32+
- an Amplifier – [AnalogAudio](https://pschatzmann.github.io/arduino-audio-tools/html/classaudio__tools_1_1_analog_audio.html)
33+
- Bluetooth Speakers – [A2DPStream](https://pschatzmann.github.io/arduino-audio-tools/html/classaudio__tools_1_1_a2_d_p_stream.html)
34+
- Serial to display the data as CSV – [CsvStream](https://pschatzmann.github.io/arduino-audio-tools/html/classaudio__tools_1_1_csv_stream.html)
3535
- SD Files
3636

3737
Here is an simple example which streams a file from the Flash Memory and writes it to I2S:

0 commit comments

Comments
 (0)