diff --git a/docs/index.md b/docs/index.md index 5a619343..b6748eb5 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,3 +1,2 @@ -This documentation is generated by Doxygen from docstrings in header files and might not include certain functions, macros, and structures that are present in header files. - -It is highly recommended to instead refer to the header files themselves as a true reference. +This documentation is generated by [Doxygen](https://www.doxygen.nl/index.html) as a convenience to Rack plugin developers and might not include certain functions, macros, and structures that are present in header files. +It is therefore recommended to refer to Rack's header files as a true reference. diff --git a/docs/logo.png b/docs/logo.png index fbb95921..3291b8bc 100644 Binary files a/docs/logo.png and b/docs/logo.png differ diff --git a/include/app/common.hpp b/include/app/common.hpp index da0a683b..e4481bbb 100644 --- a/include/app/common.hpp +++ b/include/app/common.hpp @@ -9,7 +9,7 @@ namespace rack { -/** Rack-specific GUI widgets and functions that control and offer feedback for the rack state. +/** Rack's custom UI widgets that control the Rack state and engine. */ namespace app { diff --git a/include/asset.hpp b/include/asset.hpp index d9874881..e74e21c7 100644 --- a/include/asset.hpp +++ b/include/asset.hpp @@ -15,6 +15,8 @@ struct Module; } // namespace engine +/** Handles common path locations. +*/ namespace asset { diff --git a/include/audio.hpp b/include/audio.hpp index 48319bca..34a78f19 100644 --- a/include/audio.hpp +++ b/include/audio.hpp @@ -10,7 +10,7 @@ namespace rack { -/** Audio driver +/** Abstraction for all audio drivers in Rack */ namespace audio { diff --git a/include/common.hpp b/include/common.hpp index d2216b94..66327929 100644 --- a/include/common.hpp +++ b/include/common.hpp @@ -161,6 +161,8 @@ namespace std { #endif +/** Root namespace for the Rack API +*/ namespace rack { @@ -193,8 +195,9 @@ T* construct(F f, V v, Args... args) { } -/** Defers code until the scope is destructed -From http://www.gingerbill.org/article/defer-in-cpp.html +/** Defers running code until the scope is destructed + +From http://www.gingerbill.org/article/defer-in-cpp.html. Example: file = fopen(...); diff --git a/include/componentlibrary.hpp b/include/componentlibrary.hpp index d6429354..0d4a5d46 100644 --- a/include/componentlibrary.hpp +++ b/include/componentlibrary.hpp @@ -14,14 +14,9 @@ namespace rack { -/** Component Library by [Grayscale](https://grayscale.info/). +/** Library of Rack components: knobs, ports, lights, switches, buttons, etc. -Copied from `LICENSE.md`: - -The **Component Library graphics** in the `res/ComponentLibrary` directory are copyright © 2019 [Grayscale](http://grayscale.info/) and licensed under [CC BY-NC 4.0](https://creativecommons.org/licenses/by-nc/4.0/). -You may not freely sell plugins using Component Library graphics. -However, a free commercial license is available for plugins sold through the [VCV Store](https://vcvrack.com/plugins.html). -Email contact@vcvrack.com for more information about licensing or the VCV Store. +See LICENSE.md for legal details about using Rack component graphics in your Rack plugin. */ namespace componentlibrary { diff --git a/include/context.hpp b/include/context.hpp index 79881601..244aba9d 100644 --- a/include/context.hpp +++ b/include/context.hpp @@ -29,7 +29,8 @@ struct Scene; } // namespace app -/** Contains the application state */ +/** Rack instance state +*/ struct Context { widget::EventState* event = NULL; app::Scene* scene = NULL; diff --git a/include/discord.hpp b/include/discord.hpp index 593498a1..b9c8e301 100644 --- a/include/discord.hpp +++ b/include/discord.hpp @@ -3,7 +3,7 @@ namespace rack { -/** Updates Discord "now playing" status with its IPC API +/** Updates Discord "now playing" status with IPC */ namespace discord { diff --git a/include/dsp/common.hpp b/include/dsp/common.hpp index 6949a954..e696f076 100644 --- a/include/dsp/common.hpp +++ b/include/dsp/common.hpp @@ -7,7 +7,7 @@ namespace rack { -/** Digital signal processing routines +/** Digital signal processing routines and classes */ namespace dsp { diff --git a/include/engine/Engine.hpp b/include/engine/Engine.hpp index cf743942..9b3058f4 100644 --- a/include/engine/Engine.hpp +++ b/include/engine/Engine.hpp @@ -8,6 +8,8 @@ namespace rack { +/** High-performance classes handling modules and voltage signals between them +*/ namespace engine { diff --git a/include/history.hpp b/include/history.hpp index 33b64368..7b1fc3c6 100644 --- a/include/history.hpp +++ b/include/history.hpp @@ -19,7 +19,8 @@ struct CableWidget; } // namespace app -/** Undo history actions for the Rack application */ +/** Action history for UI undo/redo +*/ namespace history { diff --git a/include/library.hpp b/include/library.hpp index c424a6cb..44e572ce 100644 --- a/include/library.hpp +++ b/include/library.hpp @@ -7,7 +7,7 @@ namespace rack { -/** Synchronizes plugins with the VCV Library and updates Rack itself +/** Synchronizes plugins with the VCV Library and handles VCV accounts with the vcvrack.com API */ namespace library { diff --git a/include/logger.hpp b/include/logger.hpp index 55492ee4..1aedfc48 100644 --- a/include/logger.hpp +++ b/include/logger.hpp @@ -18,7 +18,7 @@ will print something like namespace rack { -/** Logs messages to a file or the console with decoration +/** Logs messages to a file or the terminal */ namespace logger { diff --git a/include/math.hpp b/include/math.hpp index 7a38c448..e313b02d 100644 --- a/include/math.hpp +++ b/include/math.hpp @@ -8,7 +8,7 @@ namespace rack { -/** Supplemental `` functions and types +/** Extends `` with extra functions and types */ namespace math { diff --git a/include/midi.hpp b/include/midi.hpp index 769ab766..67421630 100644 --- a/include/midi.hpp +++ b/include/midi.hpp @@ -11,7 +11,7 @@ namespace rack { -/** MIDI driver +/** Abstraction for all MIDI drivers in Rack */ namespace midi { diff --git a/include/network.hpp b/include/network.hpp index 1d613f1f..07fc2684 100644 --- a/include/network.hpp +++ b/include/network.hpp @@ -9,7 +9,7 @@ namespace rack { -/** Networking functions for HTTP requests, URLs, and downloads +/** Networking functions for HTTP requests, downloads, and URLs */ namespace network { diff --git a/include/plugin.hpp b/include/plugin.hpp index 34fb71b2..81365661 100644 --- a/include/plugin.hpp +++ b/include/plugin.hpp @@ -9,7 +9,7 @@ namespace rack { -/** Loads and manages plugins +/** Loads and manages Rack plugins */ namespace plugin { diff --git a/include/random.hpp b/include/random.hpp index 2af5e2da..0108051b 100644 --- a/include/random.hpp +++ b/include/random.hpp @@ -7,7 +7,7 @@ namespace rack { -/** Random number generator +/** Random number generation */ namespace random { @@ -86,7 +86,7 @@ struct Xoroshiro128Plus { }; -// Easy random API +// Simple random API /** Initializes the thread-local RNG state. Must call when creating a thread, otherwise random state is undefined (might always return 0). diff --git a/include/settings.hpp b/include/settings.hpp index e7b5b1f8..6e558ad6 100644 --- a/include/settings.hpp +++ b/include/settings.hpp @@ -15,7 +15,8 @@ namespace rack { -/** Process-level globals. */ +/** Process-scope globals, most of which are persisted to a file +*/ namespace settings { diff --git a/include/simd/vector.hpp b/include/simd/vector.hpp index 989b65b2..9d255669 100644 --- a/include/simd/vector.hpp +++ b/include/simd/vector.hpp @@ -6,7 +6,8 @@ namespace rack { -/** Abstraction of byte-aligned values for SIMD CPU acceleration. */ +/** Abstraction of aligned types for SIMD computation +*/ namespace simd { diff --git a/include/system.hpp b/include/system.hpp index 5f01d76b..47bfb75b 100644 --- a/include/system.hpp +++ b/include/system.hpp @@ -7,7 +7,7 @@ namespace rack { -/** Cross-platform functions for operating systems routines +/** Cross-platform functions for operating system, file path, and filesystem routines */ namespace system { diff --git a/include/tag.hpp b/include/tag.hpp index 4431dc4f..411fb43d 100644 --- a/include/tag.hpp +++ b/include/tag.hpp @@ -5,6 +5,8 @@ namespace rack { +/** Tags describing the functions of modules +*/ namespace tag { diff --git a/include/ui/common.hpp b/include/ui/common.hpp index 349aff1f..c07557ba 100644 --- a/include/ui/common.hpp +++ b/include/ui/common.hpp @@ -16,7 +16,7 @@ namespace rack { -/** General user interface widgets using Blendish +/** Common graphical user interface widgets */ namespace ui { diff --git a/include/widget/Widget.hpp b/include/widget/Widget.hpp index e51f9529..6de5ec71 100644 --- a/include/widget/Widget.hpp +++ b/include/widget/Widget.hpp @@ -12,7 +12,7 @@ namespace rack { -/** General UI widgets +/** Basic UI widget types */ namespace widget { @@ -494,7 +494,7 @@ struct Widget : WeakBase { } // namespace widget /** Deprecated Rack v1 event namespace. -Use `FooEvent` (defined in widget::Widget) instead of `event::Foo` in new code. +Use events defined in the widget::Widget class instead of this `event::` namespace in new code. */ namespace event { using Base = widget::BaseEvent; @@ -533,4 +533,5 @@ using Show = widget::Widget::ShowEvent; using Hide = widget::Widget::HideEvent; } + } // namespace rack