From c41b62757e2d284311de551e314c11f03d938b5b Mon Sep 17 00:00:00 2001 From: Paul Licameli <paul.licameli@audacityteam.org> Date: Wed, 17 Apr 2024 09:31:36 -0400 Subject: [PATCH] Long comment at top of each CMakeLists.txt in src, libraries, modules --- libraries/CMakeLists.txt | 4 ++++ libraries/image-compiler/CMakeLists.txt | 2 +- libraries/lib-audio-devices/CMakeLists.txt | 2 +- libraries/lib-audio-unit/CMakeLists.txt | 2 +- libraries/lib-basic-ui/CMakeLists.txt | 2 +- libraries/lib-breakpad-configurer/CMakeLists.txt | 6 ++++-- libraries/lib-crashpad-configurer/CMakeLists.txt | 6 ++++-- libraries/lib-crypto/tests/CMakeLists.txt | 4 ++++ libraries/lib-exceptions/CMakeLists.txt | 2 +- libraries/lib-fft/CMakeLists.txt | 2 +- libraries/lib-files/CMakeLists.txt | 2 +- libraries/lib-graphics/CMakeLists.txt | 2 +- libraries/lib-import-export/riff-test-util/CMakeLists.txt | 4 ++++ libraries/lib-import-export/tests/CMakeLists.txt | 4 ++++ libraries/lib-math/CMakeLists.txt | 2 +- libraries/lib-math/tests/CMakeLists.txt | 4 ++++ libraries/lib-module-manager/CMakeLists.txt | 1 + .../lib-music-information-retrieval/tests/CMakeLists.txt | 4 ++++ libraries/lib-network-manager/CMakeLists.txt | 4 ++++ libraries/lib-numeric-formats/tests/CMakeLists.txt | 3 +++ libraries/lib-preferences/CMakeLists.txt | 2 +- libraries/lib-preferences/tests/CMakeLists.txt | 6 +++++- libraries/lib-project-history/CMakeLists.txt | 1 + libraries/lib-project/CMakeLists.txt | 2 +- libraries/lib-registries/CMakeLists.txt | 2 +- libraries/lib-screen-geometry/CMakeLists.txt | 2 +- libraries/lib-sentry-reporting/CMakeLists.txt | 2 +- libraries/lib-snapping/CMakeLists.txt | 1 + libraries/lib-snapping/tests/CMakeLists.txt | 3 +++ libraries/lib-sqlite-helpers/tests/CMakeLists.txt | 4 ++++ libraries/lib-stretching-sequence/CMakeLists.txt | 7 +++++-- libraries/lib-stretching-sequence/tests/CMakeLists.txt | 4 ++++ libraries/lib-string-utils/CMakeLists.txt | 4 ++++ libraries/lib-string-utils/tests/CMakeLists.txt | 4 ++++ libraries/lib-strings/CMakeLists.txt | 2 +- libraries/lib-theme/CMakeLists.txt | 2 +- libraries/lib-time-and-pitch/tests/CMakeLists.txt | 4 ++++ libraries/lib-url-schemes/CMakeLists.txt | 1 + libraries/lib-utility/CMakeLists.txt | 3 +-- libraries/lib-utility/tests/CMakeLists.txt | 3 +++ libraries/lib-uuid/CMakeLists.txt | 4 ++++ libraries/lib-viewport/CMakeLists.txt | 1 + libraries/lib-vst/CMakeLists.txt | 2 +- libraries/lib-wx-init/CMakeLists.txt | 2 +- libraries/lib-xml/CMakeLists.txt | 2 +- modules/CMakeLists.txt | 6 ++++++ modules/etc/CMakeLists.txt | 4 ++++ modules/etc/mod-null/CMakeLists.txt | 4 ++++ modules/import-export/CMakeLists.txt | 4 ++++ modules/import-export/mod-aup/CMakeLists.txt | 4 ++++ modules/import-export/mod-cl/CMakeLists.txt | 4 ++++ modules/import-export/mod-ffmpeg/CMakeLists.txt | 4 ++++ .../mod-ffmpeg/lib-ffmpeg-support/CMakeLists.txt | 3 +++ modules/import-export/mod-flac/CMakeLists.txt | 4 ++++ modules/import-export/mod-lof/CMakeLists.txt | 5 +++++ modules/import-export/mod-mp2/CMakeLists.txt | 4 ++++ modules/import-export/mod-mp3/CMakeLists.txt | 4 ++++ modules/import-export/mod-mpg123/CMakeLists.txt | 4 ++++ modules/import-export/mod-ogg/CMakeLists.txt | 4 ++++ modules/import-export/mod-opus/CMakeLists.txt | 4 ++++ modules/import-export/mod-pcm/CMakeLists.txt | 4 ++++ modules/import-export/mod-wavpack/CMakeLists.txt | 4 ++++ modules/nyquist/CMakeLists.txt | 4 ++++ modules/nyquist/mod-nyq-bench/CMakeLists.txt | 4 ++++ modules/scripting/CMakeLists.txt | 4 ++++ modules/scripting/mod-script-pipe/CMakeLists.txt | 5 +++++ modules/sharing/CMakeLists.txt | 4 ++++ modules/sharing/mod-cloud-audiocom/CMakeLists.txt | 4 ++++ modules/track-ui/CMakeLists.txt | 4 ++++ src/CMakeLists.txt | 3 +++ 70 files changed, 206 insertions(+), 28 deletions(-) diff --git a/libraries/CMakeLists.txt b/libraries/CMakeLists.txt index 1f827d46b1..d22871b313 100644 --- a/libraries/CMakeLists.txt +++ b/libraries/CMakeLists.txt @@ -1,3 +1,7 @@ +#[[ +A directory containing library targets +]] + # Include the libraries that we'll build # The list of modules is ordered so that each library occurs after any others diff --git a/libraries/image-compiler/CMakeLists.txt b/libraries/image-compiler/CMakeLists.txt index a91007c959..14931d105e 100644 --- a/libraries/image-compiler/CMakeLists.txt +++ b/libraries/image-compiler/CMakeLists.txt @@ -2,7 +2,7 @@ A small program that is run at build time of the application. For each built-in theme it generates a header file from image files. The images are part of the source code tree but not deployed with the program. -]]# +]] if( NOT IMAGE_COMPILER_EXECUTABLE ) add_executable( image-compiler imageCompilerMain.cpp ) diff --git a/libraries/lib-audio-devices/CMakeLists.txt b/libraries/lib-audio-devices/CMakeLists.txt index 997ffc61b3..b4f161ab34 100644 --- a/libraries/lib-audio-devices/CMakeLists.txt +++ b/libraries/lib-audio-devices/CMakeLists.txt @@ -8,7 +8,7 @@ Also abstract class Meter for communicating buffers of samples for display purposes. Does not contain an audio engine. -]]# +]] set( SOURCES AudioIOBase.cpp diff --git a/libraries/lib-audio-unit/CMakeLists.txt b/libraries/lib-audio-unit/CMakeLists.txt index 4a5bdac9c5..1e3dad538b 100644 --- a/libraries/lib-audio-unit/CMakeLists.txt +++ b/libraries/lib-audio-unit/CMakeLists.txt @@ -1,6 +1,6 @@ #[[ AudioUnit effect processing logic, minus user interface -]]# +]] if (USE_AUDIO_UNITS) diff --git a/libraries/lib-basic-ui/CMakeLists.txt b/libraries/lib-basic-ui/CMakeLists.txt index 22e7487b5c..f94c422ab5 100644 --- a/libraries/lib-basic-ui/CMakeLists.txt +++ b/libraries/lib-basic-ui/CMakeLists.txt @@ -11,7 +11,7 @@ There is a global pointer to an instance of Services, and the main program is expected, at startup, to create a static instance of a subclass of Services and set the pointer. If it does not, then calls to the non-member functions in namespace BasicUI are no-ops. -]]# +]] set( SOURCES BasicUI.cpp diff --git a/libraries/lib-breakpad-configurer/CMakeLists.txt b/libraries/lib-breakpad-configurer/CMakeLists.txt index 4b853b2794..e299496e26 100644 --- a/libraries/lib-breakpad-configurer/CMakeLists.txt +++ b/libraries/lib-breakpad-configurer/CMakeLists.txt @@ -1,5 +1,7 @@ -# This module provides an interface to configure and start Breakpad handler -# in a platform independent way. +#[[ +This library provides an interface to configure and start Breakpad handler +in a platform independent way. +]] set(SOURCES BreakpadConfigurer.h diff --git a/libraries/lib-crashpad-configurer/CMakeLists.txt b/libraries/lib-crashpad-configurer/CMakeLists.txt index 818de89b25..7bb57e6adc 100644 --- a/libraries/lib-crashpad-configurer/CMakeLists.txt +++ b/libraries/lib-crashpad-configurer/CMakeLists.txt @@ -1,5 +1,7 @@ -# This module provides an interface to configure and start Crashpad handler -# in a platform independent way. +#[[ +This library provides an interface to configure and start Crashpad handler +in a platform independent way. +]] set(SOURCES CrashpadConfigurer.h diff --git a/libraries/lib-crypto/tests/CMakeLists.txt b/libraries/lib-crypto/tests/CMakeLists.txt index cc46b7d798..7eaa22fe28 100644 --- a/libraries/lib-crypto/tests/CMakeLists.txt +++ b/libraries/lib-crypto/tests/CMakeLists.txt @@ -1,3 +1,7 @@ +#[[ +Unit tests for lib-crypto +]] + add_unit_test( NAME lib-crypto diff --git a/libraries/lib-exceptions/CMakeLists.txt b/libraries/lib-exceptions/CMakeLists.txt index 64a74b3bd2..e8d5bd059c 100644 --- a/libraries/lib-exceptions/CMakeLists.txt +++ b/libraries/lib-exceptions/CMakeLists.txt @@ -13,7 +13,7 @@ enqueues the delayed action. But this library does NOT define a top-level handler for the whole application, to catch all otherwise uncaught exceptions. That is a responsibility of high level code. -]]# +]] set( SOURCES AudacityException.cpp diff --git a/libraries/lib-fft/CMakeLists.txt b/libraries/lib-fft/CMakeLists.txt index 72404e7773..d08a220a33 100644 --- a/libraries/lib-fft/CMakeLists.txt +++ b/libraries/lib-fft/CMakeLists.txt @@ -4,7 +4,7 @@ A library for fast fourier transforms Note -- this cannot be combined with lib-math, which depends on libsoxr, which includes a different version of pffft.h -]]# +]] set( SOURCES FFT.cpp diff --git a/libraries/lib-files/CMakeLists.txt b/libraries/lib-files/CMakeLists.txt index bdb9f27f67..4215402079 100644 --- a/libraries/lib-files/CMakeLists.txt +++ b/libraries/lib-files/CMakeLists.txt @@ -6,7 +6,7 @@ Also the definition of certain significant file paths, such as the directory for temporary projects. Also the global logger which can save to a file. -]]# +]] set( SOURCES AudacityLogger.cpp diff --git a/libraries/lib-graphics/CMakeLists.txt b/libraries/lib-graphics/CMakeLists.txt index 7c71da4bcb..a7cfbddb09 100644 --- a/libraries/lib-graphics/CMakeLists.txt +++ b/libraries/lib-graphics/CMakeLists.txt @@ -1,6 +1,6 @@ #[[ A library responsible for custom rendering in Audacity -]]# +]] set( SOURCES FrameStatistics.cpp diff --git a/libraries/lib-import-export/riff-test-util/CMakeLists.txt b/libraries/lib-import-export/riff-test-util/CMakeLists.txt index 5939843feb..1e40c71b39 100644 --- a/libraries/lib-import-export/riff-test-util/CMakeLists.txt +++ b/libraries/lib-import-export/riff-test-util/CMakeLists.txt @@ -1,3 +1,7 @@ +#[[ +A command line testing program for tempo metadata in files +]] + add_executable(riff-test-util RiffTestUtil.cpp ) diff --git a/libraries/lib-import-export/tests/CMakeLists.txt b/libraries/lib-import-export/tests/CMakeLists.txt index 8d82fb6466..6202f592b8 100644 --- a/libraries/lib-import-export/tests/CMakeLists.txt +++ b/libraries/lib-import-export/tests/CMakeLists.txt @@ -1,3 +1,7 @@ +#[[ +Unit tests for lib-import-export +]] + add_unit_test( NAME lib-import-export diff --git a/libraries/lib-math/CMakeLists.txt b/libraries/lib-math/CMakeLists.txt index 102ec0437f..19637c5972 100644 --- a/libraries/lib-math/CMakeLists.txt +++ b/libraries/lib-math/CMakeLists.txt @@ -1,6 +1,6 @@ #[[ A library of mathematical utilities and manipulation of samples -]]# +]] addlib( libsoxr soxr SOXR YES YES "soxr >= 0.1.1" ) diff --git a/libraries/lib-math/tests/CMakeLists.txt b/libraries/lib-math/tests/CMakeLists.txt index 944cd83fe1..8664d2e7b6 100644 --- a/libraries/lib-math/tests/CMakeLists.txt +++ b/libraries/lib-math/tests/CMakeLists.txt @@ -1,3 +1,7 @@ +#[[ +Unit tests for lib-math +]] + add_unit_test( NAME lib-math diff --git a/libraries/lib-module-manager/CMakeLists.txt b/libraries/lib-module-manager/CMakeLists.txt index ced0a1781e..10c723213c 100644 --- a/libraries/lib-module-manager/CMakeLists.txt +++ b/libraries/lib-module-manager/CMakeLists.txt @@ -5,6 +5,7 @@ effect, generator, and analyzer plug-ins. Maintains persistent data in the configuration file for enablement of modules and plug-ins, and preferred settings. ]] + set( SOURCES AsyncPluginValidator.cpp AsyncPluginValidator.h diff --git a/libraries/lib-music-information-retrieval/tests/CMakeLists.txt b/libraries/lib-music-information-retrieval/tests/CMakeLists.txt index 36bc8a21cf..48df27a34c 100644 --- a/libraries/lib-music-information-retrieval/tests/CMakeLists.txt +++ b/libraries/lib-music-information-retrieval/tests/CMakeLists.txt @@ -1,3 +1,7 @@ +#[[ +Unit tests for lib-music-information-retrieval +]] + add_compile_definitions( CMAKE_CURRENT_SOURCE_DIR="${CMAKE_CURRENT_SOURCE_DIR}" ) diff --git a/libraries/lib-network-manager/CMakeLists.txt b/libraries/lib-network-manager/CMakeLists.txt index 161e35a38d..9f427ad1af 100644 --- a/libraries/lib-network-manager/CMakeLists.txt +++ b/libraries/lib-network-manager/CMakeLists.txt @@ -1,3 +1,7 @@ +#[[ +Asynchronously send and receive requests and responses over internet +]] + set(TARGET lib-network-manager) set( TARGET_ROOT ${CMAKE_CURRENT_SOURCE_DIR} ) diff --git a/libraries/lib-numeric-formats/tests/CMakeLists.txt b/libraries/lib-numeric-formats/tests/CMakeLists.txt index 5f1294f88c..f6b48a9731 100644 --- a/libraries/lib-numeric-formats/tests/CMakeLists.txt +++ b/libraries/lib-numeric-formats/tests/CMakeLists.txt @@ -1,4 +1,7 @@ # SPDX-License-Identifier: GPL-2.0-or-later +#[[ +Unit tests for lib-numeric-formats +]] add_unit_test( NAME diff --git a/libraries/lib-preferences/CMakeLists.txt b/libraries/lib-preferences/CMakeLists.txt index e7fa0856e3..bf5bc90b08 100644 --- a/libraries/lib-preferences/CMakeLists.txt +++ b/libraries/lib-preferences/CMakeLists.txt @@ -12,7 +12,7 @@ PreferenceInitializer is a callback for the reinitialization of preferences. FileConfig decorates wxFileConfig, with a member function to alert the user of failure to initialize it (as when the file is read-only). -]]# +]] set( SOURCES BasicSettings.cpp diff --git a/libraries/lib-preferences/tests/CMakeLists.txt b/libraries/lib-preferences/tests/CMakeLists.txt index 0d71e51eaf..45e793f987 100644 --- a/libraries/lib-preferences/tests/CMakeLists.txt +++ b/libraries/lib-preferences/tests/CMakeLists.txt @@ -1,3 +1,7 @@ +#[[ +Unit tests for lib-preferences +]] + add_unit_test( NAME lib-preferences @@ -8,4 +12,4 @@ add_unit_test( LIBRARIES lib-preferences lib-wx-init -) \ No newline at end of file +) diff --git a/libraries/lib-project-history/CMakeLists.txt b/libraries/lib-project-history/CMakeLists.txt index a458d23e94..9082506338 100644 --- a/libraries/lib-project-history/CMakeLists.txt +++ b/libraries/lib-project-history/CMakeLists.txt @@ -2,6 +2,7 @@ Management of undo and redo history of the project, stored as states, not deltas. There is not yet persistency of undo history across sessions. ]] + set( SOURCES ProjectHistory.cpp ProjectHistory.h diff --git a/libraries/lib-project/CMakeLists.txt b/libraries/lib-project/CMakeLists.txt index 778750ead0..e1d1e04e6a 100644 --- a/libraries/lib-project/CMakeLists.txt +++ b/libraries/lib-project/CMakeLists.txt @@ -7,7 +7,7 @@ Also a global array of existing projects. Also ProjectStatus, an abstraction of the status bar, just holding some strings and formatter functions, and emitting events when changed. -]]# +]] set( SOURCES Project.cpp diff --git a/libraries/lib-registries/CMakeLists.txt b/libraries/lib-registries/CMakeLists.txt index 2d985918dd..c57788ff8f 100644 --- a/libraries/lib-registries/CMakeLists.txt +++ b/libraries/lib-registries/CMakeLists.txt @@ -25,7 +25,7 @@ Registry implements trees of objects identified by textual paths, and allows scattered code to insert items or subtrees at specified paths. Registry computes the merging of trees, and supports visitation. It is used notably by the tree of menus, allowing insertion of menu items in decoupled code. -]]# +]] set( SOURCES AttachedVirtualFunction.h diff --git a/libraries/lib-screen-geometry/CMakeLists.txt b/libraries/lib-screen-geometry/CMakeLists.txt index 5765183fb5..77be24bab9 100644 --- a/libraries/lib-screen-geometry/CMakeLists.txt +++ b/libraries/lib-screen-geometry/CMakeLists.txt @@ -1,7 +1,7 @@ #[[ Classes relating to the mappings between x or y coordinates of the screen, and times, or frequencies, or amplitudes. -]]# +]] set( SOURCES NumberScale.h diff --git a/libraries/lib-sentry-reporting/CMakeLists.txt b/libraries/lib-sentry-reporting/CMakeLists.txt index 0d97c9f20e..b9b407c028 100644 --- a/libraries/lib-sentry-reporting/CMakeLists.txt +++ b/libraries/lib-sentry-reporting/CMakeLists.txt @@ -1,7 +1,7 @@ #[[ A library, that allows sending error reports to a Sentry server using Exception and Message interfaces. -]]# +]] set( TARGET lib-sentry-reporting ) set( TARGET_ROOT ${CMAKE_CURRENT_SOURCE_DIR} ) diff --git a/libraries/lib-snapping/CMakeLists.txt b/libraries/lib-snapping/CMakeLists.txt index a68ab40005..fc089c9446 100644 --- a/libraries/lib-snapping/CMakeLists.txt +++ b/libraries/lib-snapping/CMakeLists.txt @@ -8,6 +8,7 @@ This library: 3. Provides a project extension that is responsible for snapping ]] + set(TARGET lib-snapping) set(TARGET_ROOT ${CMAKE_CURRENT_SOURCE_DIR} ) diff --git a/libraries/lib-snapping/tests/CMakeLists.txt b/libraries/lib-snapping/tests/CMakeLists.txt index 947269ef39..2449dc5cbb 100644 --- a/libraries/lib-snapping/tests/CMakeLists.txt +++ b/libraries/lib-snapping/tests/CMakeLists.txt @@ -1,4 +1,7 @@ # SPDX-License-Identifier: GPL-2.0-or-later +#[[ +Unit tests for lib-snapping +]] add_unit_test( NAME diff --git a/libraries/lib-sqlite-helpers/tests/CMakeLists.txt b/libraries/lib-sqlite-helpers/tests/CMakeLists.txt index ffa7784fd0..7261bc6bb8 100644 --- a/libraries/lib-sqlite-helpers/tests/CMakeLists.txt +++ b/libraries/lib-sqlite-helpers/tests/CMakeLists.txt @@ -1,3 +1,7 @@ +#[[ +Unit tests for lib-sqlite +]] + add_unit_test( NAME lib-sqlite-helpers diff --git a/libraries/lib-stretching-sequence/CMakeLists.txt b/libraries/lib-stretching-sequence/CMakeLists.txt index 6c7a39ff31..da4ff6fda3 100644 --- a/libraries/lib-stretching-sequence/CMakeLists.txt +++ b/libraries/lib-stretching-sequence/CMakeLists.txt @@ -1,8 +1,11 @@ #[[ -A library providing a time-stretching-capable implementation of `PlayableSequence`. +A library providing a time-stretching-capable implementation of +`PlayableSequence`. -Please refer to this directory's readme for a presentation of the constraints inherent to such an implementation. +Please refer to this directory's readme for a presentation of the constraints +inherent to such an implementation. ]] + set( SOURCES AudioSegment.cpp AudioSegment.h diff --git a/libraries/lib-stretching-sequence/tests/CMakeLists.txt b/libraries/lib-stretching-sequence/tests/CMakeLists.txt index 438354736a..1e1015c84e 100644 --- a/libraries/lib-stretching-sequence/tests/CMakeLists.txt +++ b/libraries/lib-stretching-sequence/tests/CMakeLists.txt @@ -1,3 +1,7 @@ +#[[ +Unit tests for lib-stretching-sequence +]] + add_compile_definitions(CMAKE_SOURCE_DIR="${CMAKE_SOURCE_DIR}") add_unit_test( diff --git a/libraries/lib-string-utils/CMakeLists.txt b/libraries/lib-string-utils/CMakeLists.txt index 62d426ae9c..8ba0afa60e 100644 --- a/libraries/lib-string-utils/CMakeLists.txt +++ b/libraries/lib-string-utils/CMakeLists.txt @@ -1,3 +1,7 @@ +#[[ +String encoding and formatting utilities +]] + set(TARGET lib-string-utils) set(TARGET_ROOT ${CMAKE_CURRENT_SOURCE_DIR} ) diff --git a/libraries/lib-string-utils/tests/CMakeLists.txt b/libraries/lib-string-utils/tests/CMakeLists.txt index 499ea33b8c..906c2ccf69 100644 --- a/libraries/lib-string-utils/tests/CMakeLists.txt +++ b/libraries/lib-string-utils/tests/CMakeLists.txt @@ -1,3 +1,7 @@ +#[[ +Unit tests for lib-string-utils +]] + add_unit_test( NAME lib-string-utils diff --git a/libraries/lib-strings/CMakeLists.txt b/libraries/lib-strings/CMakeLists.txt index b8cf75d29b..69593b7a7e 100644 --- a/libraries/lib-strings/CMakeLists.txt +++ b/libraries/lib-strings/CMakeLists.txt @@ -11,7 +11,7 @@ even if the global choice of locale changes during its lifetime. It does not implicitly interconvert with wxString. This library depends only on the wxBase subset of wxWidgets. -]]# +]] set( SOURCES Base64.h diff --git a/libraries/lib-theme/CMakeLists.txt b/libraries/lib-theme/CMakeLists.txt index e43c09ed14..021d96e6b6 100644 --- a/libraries/lib-theme/CMakeLists.txt +++ b/libraries/lib-theme/CMakeLists.txt @@ -1,7 +1,7 @@ #[[ A library to hold a registry of image and color identifiers, and multiple themes associating data with those identifiers. -]]# +]] set( SOURCES AColor.cpp diff --git a/libraries/lib-time-and-pitch/tests/CMakeLists.txt b/libraries/lib-time-and-pitch/tests/CMakeLists.txt index e0cc8fcd9f..b3e98a101a 100644 --- a/libraries/lib-time-and-pitch/tests/CMakeLists.txt +++ b/libraries/lib-time-and-pitch/tests/CMakeLists.txt @@ -1,3 +1,7 @@ +#[[ +Unit tests for lib-time-and-pitch +]] + add_compile_definitions(CMAKE_SOURCE_DIR="${CMAKE_SOURCE_DIR}") add_unit_test( diff --git a/libraries/lib-url-schemes/CMakeLists.txt b/libraries/lib-url-schemes/CMakeLists.txt index d5ecb9ea7f..5a2ae0c645 100644 --- a/libraries/lib-url-schemes/CMakeLists.txt +++ b/libraries/lib-url-schemes/CMakeLists.txt @@ -2,6 +2,7 @@ #[[ Library, responsible for handling custom URL scemas. ]] + set( SOURCES URLSchemesRegistry.cpp URLSchemesRegistry.h diff --git a/libraries/lib-utility/CMakeLists.txt b/libraries/lib-utility/CMakeLists.txt index 9c547e885a..94c60c3d2f 100644 --- a/libraries/lib-utility/CMakeLists.txt +++ b/libraries/lib-utility/CMakeLists.txt @@ -12,8 +12,7 @@ did not yet provide std::make_unique. That explains the name. Audacity now uses C++17, and yet, need arose for other anticipations of future standards. It also provides other pervasively used utilities that don't correspond to things in the standard. - -]]# +]] set( SOURCES AppEvents.cpp diff --git a/libraries/lib-utility/tests/CMakeLists.txt b/libraries/lib-utility/tests/CMakeLists.txt index fcf7f19c66..7f3e96340c 100644 --- a/libraries/lib-utility/tests/CMakeLists.txt +++ b/libraries/lib-utility/tests/CMakeLists.txt @@ -1,4 +1,7 @@ # SPDX-License-Identifier: GPL-2.0-or-later +#[[ +Unit tests for lib-utility +]] add_unit_test( NAME diff --git a/libraries/lib-uuid/CMakeLists.txt b/libraries/lib-uuid/CMakeLists.txt index 85ffdaab12..4a42d5f203 100644 --- a/libraries/lib-uuid/CMakeLists.txt +++ b/libraries/lib-uuid/CMakeLists.txt @@ -1,3 +1,7 @@ +#[[ +Generation of UUIDs +]] + set( TARGET lib-uuid ) set( TARGET_ROOT ${CMAKE_CURRENT_SOURCE_DIR} ) diff --git a/libraries/lib-viewport/CMakeLists.txt b/libraries/lib-viewport/CMakeLists.txt index 7e90f6899c..707c3bf63d 100644 --- a/libraries/lib-viewport/CMakeLists.txt +++ b/libraries/lib-viewport/CMakeLists.txt @@ -2,6 +2,7 @@ Viewport defines a callback facade for horizontal and vertical scrollbars, and provides methods to scroll and zoom the view of tracks. ]] + set( SOURCES Viewport.cpp Viewport.h diff --git a/libraries/lib-vst/CMakeLists.txt b/libraries/lib-vst/CMakeLists.txt index 8fa10c4b6e..6d556f2a6b 100644 --- a/libraries/lib-vst/CMakeLists.txt +++ b/libraries/lib-vst/CMakeLists.txt @@ -1,6 +1,6 @@ #[[ VST 2 effect plugin discovery and processing logic, without user interface -]]# +]] set( SOURCES VSTEffectBase.cpp diff --git a/libraries/lib-wx-init/CMakeLists.txt b/libraries/lib-wx-init/CMakeLists.txt index f27e9e397a..4852e20942 100644 --- a/libraries/lib-wx-init/CMakeLists.txt +++ b/libraries/lib-wx-init/CMakeLists.txt @@ -1,7 +1,7 @@ #[[ Startup time injections of wxWidgets based implementations of services behind toolkit-neutral facades -]]# +]] set( SOURCES AccessibleLinksFormatter.cpp diff --git a/libraries/lib-xml/CMakeLists.txt b/libraries/lib-xml/CMakeLists.txt index d5120d0d33..ab260444e1 100644 --- a/libraries/lib-xml/CMakeLists.txt +++ b/libraries/lib-xml/CMakeLists.txt @@ -3,7 +3,7 @@ Utilities to serialize and deserialize trees of objects in XML form, and a class template XMLMethodRegistry to generate registries for serializable objects attached to a host object. The template is parametrized by the host type. -]]# +]] set( SOURCES XMLAttributeValueView.cpp diff --git a/modules/CMakeLists.txt b/modules/CMakeLists.txt index 3e55c2c021..ed9acdd0fc 100644 --- a/modules/CMakeLists.txt +++ b/modules/CMakeLists.txt @@ -1,3 +1,9 @@ +#[[ +A directory of directories of module targets. Sub-directories group modules in +some common area of functionality, such as import/export, and each group becomes +a cluster in the modules.dot file generated at configuration time. +]] + # Include the modules that we'll build # The list of module sub-folders is ordered so that each folder occurs after any diff --git a/modules/etc/CMakeLists.txt b/modules/etc/CMakeLists.txt index 89cfda5d54..77a5054ead 100644 --- a/modules/etc/CMakeLists.txt +++ b/modules/etc/CMakeLists.txt @@ -1,3 +1,7 @@ +#[[ +A subdirectory containing module targets +]] + # Include the modules that we'll build # The list of modules is ordered so that each module occurs after any others diff --git a/modules/etc/mod-null/CMakeLists.txt b/modules/etc/mod-null/CMakeLists.txt index d00e23288a..b1ec2c2051 100644 --- a/modules/etc/mod-null/CMakeLists.txt +++ b/modules/etc/mod-null/CMakeLists.txt @@ -1,3 +1,7 @@ +#[[ +A skeletal example module that does nothing +]] + set( TARGET mod-null ) set( DEFINES PRIVATE diff --git a/modules/import-export/CMakeLists.txt b/modules/import-export/CMakeLists.txt index eae7ef4a7d..bbcff616f9 100644 --- a/modules/import-export/CMakeLists.txt +++ b/modules/import-export/CMakeLists.txt @@ -1,3 +1,7 @@ +#[[ +A subdirectory containing module targets +]] + # Include the modules that we'll build # The list of modules is ordered so that each module occurs after any others diff --git a/modules/import-export/mod-aup/CMakeLists.txt b/modules/import-export/mod-aup/CMakeLists.txt index 455cdea7e4..067c9d962d 100644 --- a/modules/import-export/mod-aup/CMakeLists.txt +++ b/modules/import-export/mod-aup/CMakeLists.txt @@ -1,3 +1,7 @@ +#[[ +Import of older Audacity project files, in .aup format, saved before version 3.0 +]] + set( TARGET mod-aup ) set( SOURCES diff --git a/modules/import-export/mod-cl/CMakeLists.txt b/modules/import-export/mod-cl/CMakeLists.txt index 3da967fd9c..740c6d9fd0 100644 --- a/modules/import-export/mod-cl/CMakeLists.txt +++ b/modules/import-export/mod-cl/CMakeLists.txt @@ -1,3 +1,7 @@ +#[[ +Export of files with a command passed to a command-line shell +]] + set( TARGET mod-cl ) set( SOURCES diff --git a/modules/import-export/mod-ffmpeg/CMakeLists.txt b/modules/import-export/mod-ffmpeg/CMakeLists.txt index 0bd9acbfa7..8f6e39782d 100644 --- a/modules/import-export/mod-ffmpeg/CMakeLists.txt +++ b/modules/import-export/mod-ffmpeg/CMakeLists.txt @@ -1,3 +1,7 @@ +#[[ +FFmpeg import and export +]] + set( TARGET mod-ffmpeg ) add_subdirectory(lib-ffmpeg-support) diff --git a/modules/import-export/mod-ffmpeg/lib-ffmpeg-support/CMakeLists.txt b/modules/import-export/mod-ffmpeg/lib-ffmpeg-support/CMakeLists.txt index 3a3a0a20c3..a298b9c950 100644 --- a/modules/import-export/mod-ffmpeg/lib-ffmpeg-support/CMakeLists.txt +++ b/modules/import-export/mod-ffmpeg/lib-ffmpeg-support/CMakeLists.txt @@ -1,3 +1,6 @@ +#[[ +Various versions of FFmpeg and a facade to hide their binary incompatibilities +]] if (${_OPT}use_ffmpeg) set( SOURCES diff --git a/modules/import-export/mod-flac/CMakeLists.txt b/modules/import-export/mod-flac/CMakeLists.txt index 72e998f408..58da38ba03 100644 --- a/modules/import-export/mod-flac/CMakeLists.txt +++ b/modules/import-export/mod-flac/CMakeLists.txt @@ -1,3 +1,7 @@ +#[[ +FLAC import and export +]] + set( TARGET mod-flac ) set( SOURCES diff --git a/modules/import-export/mod-lof/CMakeLists.txt b/modules/import-export/mod-lof/CMakeLists.txt index 7a7a601934..cc5bc9c93c 100644 --- a/modules/import-export/mod-lof/CMakeLists.txt +++ b/modules/import-export/mod-lof/CMakeLists.txt @@ -1,3 +1,8 @@ +#[[ +Interpret .lof (list-of-files) format, a simple language that can name other +files to import and then time-shift +]] + set( TARGET mod-lof ) set( SOURCES diff --git a/modules/import-export/mod-mp2/CMakeLists.txt b/modules/import-export/mod-mp2/CMakeLists.txt index ec904b88e4..8a27c5b91c 100644 --- a/modules/import-export/mod-mp2/CMakeLists.txt +++ b/modules/import-export/mod-mp2/CMakeLists.txt @@ -1,3 +1,7 @@ +#[[ +MP2 export +]] + set( TARGET mod-mp2 ) set( SOURCES diff --git a/modules/import-export/mod-mp3/CMakeLists.txt b/modules/import-export/mod-mp3/CMakeLists.txt index de2d789ab0..9ba97a2fa9 100644 --- a/modules/import-export/mod-mp3/CMakeLists.txt +++ b/modules/import-export/mod-mp3/CMakeLists.txt @@ -1,3 +1,7 @@ +#[[ +MP3 export using the LAME library +]] + set( TARGET mod-mp3 ) set( SOURCES diff --git a/modules/import-export/mod-mpg123/CMakeLists.txt b/modules/import-export/mod-mpg123/CMakeLists.txt index 9d10788c34..57577ec42d 100644 --- a/modules/import-export/mod-mpg123/CMakeLists.txt +++ b/modules/import-export/mod-mpg123/CMakeLists.txt @@ -1,3 +1,7 @@ +#[[ +MPG123 import +]] + set( TARGET mod-mpg123 ) set( SOURCES diff --git a/modules/import-export/mod-ogg/CMakeLists.txt b/modules/import-export/mod-ogg/CMakeLists.txt index f264a587ef..27f387b30a 100644 --- a/modules/import-export/mod-ogg/CMakeLists.txt +++ b/modules/import-export/mod-ogg/CMakeLists.txt @@ -1,3 +1,7 @@ +#[[ +OGG import and export +]] + set( TARGET mod-ogg ) set( SOURCES diff --git a/modules/import-export/mod-opus/CMakeLists.txt b/modules/import-export/mod-opus/CMakeLists.txt index 66b3c4732a..a67ac7064c 100644 --- a/modules/import-export/mod-opus/CMakeLists.txt +++ b/modules/import-export/mod-opus/CMakeLists.txt @@ -1,3 +1,7 @@ +#[[ +Opus import and export +]] + set( TARGET mod-opus ) set( SOURCES diff --git a/modules/import-export/mod-pcm/CMakeLists.txt b/modules/import-export/mod-pcm/CMakeLists.txt index 35718b4eff..e8ce7bd31d 100644 --- a/modules/import-export/mod-pcm/CMakeLists.txt +++ b/modules/import-export/mod-pcm/CMakeLists.txt @@ -1,3 +1,7 @@ +#[[ +PCM (that is .wav file) import and export +]] + set( TARGET mod-pcm ) set( SOURCES diff --git a/modules/import-export/mod-wavpack/CMakeLists.txt b/modules/import-export/mod-wavpack/CMakeLists.txt index 40e360662f..d636f3d8bd 100644 --- a/modules/import-export/mod-wavpack/CMakeLists.txt +++ b/modules/import-export/mod-wavpack/CMakeLists.txt @@ -1,3 +1,7 @@ +#[[ +WavPack import and export +]] + set( TARGET mod-wavpack ) set( SOURCES diff --git a/modules/nyquist/CMakeLists.txt b/modules/nyquist/CMakeLists.txt index 004cbb8f23..6d86aa662b 100644 --- a/modules/nyquist/CMakeLists.txt +++ b/modules/nyquist/CMakeLists.txt @@ -1,3 +1,7 @@ +#[[ +A directory containing modules related to the Nyquist language +]] + # Include the modules that we'll build # The list of modules is ordered so that each module occurs after any others diff --git a/modules/nyquist/mod-nyq-bench/CMakeLists.txt b/modules/nyquist/mod-nyq-bench/CMakeLists.txt index 7e328c62f1..0a50abf5ff 100644 --- a/modules/nyquist/mod-nyq-bench/CMakeLists.txt +++ b/modules/nyquist/mod-nyq-bench/CMakeLists.txt @@ -1,3 +1,7 @@ +#[[ +Experimental module for interactive development of Nyquist plugins +]] + set( TARGET mod-nyq-bench ) set( SOURCES NyqBench.cpp diff --git a/modules/scripting/CMakeLists.txt b/modules/scripting/CMakeLists.txt index cccb25c77e..faa55b1803 100644 --- a/modules/scripting/CMakeLists.txt +++ b/modules/scripting/CMakeLists.txt @@ -1,3 +1,7 @@ +#[[ +A directory containing module targets +]] + # Include the modules that we'll build # The list of modules is ordered so that each module occurs after any others diff --git a/modules/scripting/mod-script-pipe/CMakeLists.txt b/modules/scripting/mod-script-pipe/CMakeLists.txt index 9bb867f026..64cfdd8d08 100644 --- a/modules/scripting/mod-script-pipe/CMakeLists.txt +++ b/modules/scripting/mod-script-pipe/CMakeLists.txt @@ -1,3 +1,8 @@ +#[[ +Inter-process pipe allowing control of Audacity by sending macro commands and +receiving responses +]] + set( SOURCES PipeServer.cpp ScripterCallback.cpp diff --git a/modules/sharing/CMakeLists.txt b/modules/sharing/CMakeLists.txt index 0ab6a99a94..f8272955f3 100644 --- a/modules/sharing/CMakeLists.txt +++ b/modules/sharing/CMakeLists.txt @@ -1,3 +1,7 @@ +#[[ +A directory containing module targets +]] + # Include the modules that we'll build # The list of modules is ordered so that each module occurs after any others diff --git a/modules/sharing/mod-cloud-audiocom/CMakeLists.txt b/modules/sharing/mod-cloud-audiocom/CMakeLists.txt index e108626fd0..e730f1b994 100644 --- a/modules/sharing/mod-cloud-audiocom/CMakeLists.txt +++ b/modules/sharing/mod-cloud-audiocom/CMakeLists.txt @@ -1,3 +1,7 @@ +#[[ +Upload and download of project files in the cloud +]] + set( TARGET mod-cloud-audiocom ) set( SOURCES diff --git a/modules/track-ui/CMakeLists.txt b/modules/track-ui/CMakeLists.txt index b1db0fd798..71b7e6fc95 100644 --- a/modules/track-ui/CMakeLists.txt +++ b/modules/track-ui/CMakeLists.txt @@ -1,3 +1,7 @@ +#[[ +A directory of module targets +]] + # Include the modules that we'll build # The list of modules is ordered so that each module occurs after any others diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt index 1c9ab924b7..32370c55f4 100644 --- a/src/CMakeLists.txt +++ b/src/CMakeLists.txt @@ -1,3 +1,6 @@ +#[[ +Configure the executable, modules, and libraries +]] set( TARGET Audacity ) set( TARGET_ROOT ${topdir}/src ) -- GitLab