From 6d5a76788f6161748efb4747ba9c2d7654216c88 Mon Sep 17 00:00:00 2001 From: Andrew Belt Date: Sat, 25 Sep 2021 09:46:46 -0400 Subject: [PATCH] Adjust formatting of namespace docs. --- include/asset.hpp | 3 +-- include/audio.hpp | 5 +---- include/color.hpp | 4 +--- include/common.hpp | 3 +-- include/discord.hpp | 5 ++--- include/gamepad.hpp | 5 +---- include/history.hpp | 3 +-- include/keyboard.hpp | 5 +---- include/library.hpp | 5 +---- include/logger.hpp | 5 +---- include/math.hpp | 5 +---- include/midi.hpp | 5 +---- include/network.hpp | 5 +---- include/patch.hpp | 1 + include/plugin.hpp | 5 +---- include/random.hpp | 5 +---- include/settings.hpp | 5 +---- include/string.hpp | 5 +---- include/system.hpp | 5 +---- include/tag.hpp | 3 +-- include/weakptr.hpp | 3 +-- include/widget/SvgWidget.hpp | 2 +- include/widget/Widget.hpp | 9 +++------ include/window/Svg.hpp | 1 + 24 files changed, 27 insertions(+), 75 deletions(-) diff --git a/include/asset.hpp b/include/asset.hpp index e74e21c7..49877c2e 100644 --- a/include/asset.hpp +++ b/include/asset.hpp @@ -15,8 +15,7 @@ struct Module; } // namespace engine -/** Handles common path locations. -*/ +/** Handles common path locations */ namespace asset { diff --git a/include/audio.hpp b/include/audio.hpp index 34a78f19..0f52ce46 100644 --- a/include/audio.hpp +++ b/include/audio.hpp @@ -8,10 +8,7 @@ #include namespace rack { - - -/** Abstraction for all audio drivers in Rack -*/ +/** Abstraction for all audio drivers in Rack */ namespace audio { diff --git a/include/color.hpp b/include/color.hpp index 2fd21e75..b0f251ac 100644 --- a/include/color.hpp +++ b/include/color.hpp @@ -6,9 +6,7 @@ namespace rack { - -/** Utilities for `NVGcolor` -*/ +/** Utilities for `NVGcolor` */ namespace color { diff --git a/include/common.hpp b/include/common.hpp index 66327929..40fbab93 100644 --- a/include/common.hpp +++ b/include/common.hpp @@ -161,8 +161,7 @@ namespace std { #endif -/** Root namespace for the Rack API -*/ +/** Root namespace for the Rack API */ namespace rack { diff --git a/include/discord.hpp b/include/discord.hpp index b9c8e301..d4ceb4ee 100644 --- a/include/discord.hpp +++ b/include/discord.hpp @@ -1,10 +1,9 @@ #pragma once #include -namespace rack { -/** Updates Discord "now playing" status with IPC -*/ +namespace rack { +/** Updates Discord "now playing" status with IPC */ namespace discord { diff --git a/include/gamepad.hpp b/include/gamepad.hpp index bf41ec2c..d52c9d75 100644 --- a/include/gamepad.hpp +++ b/include/gamepad.hpp @@ -3,10 +3,7 @@ namespace rack { - - -/** Gamepad/joystick/controller MIDI driver -*/ +/** Gamepad/joystick/controller MIDI driver */ namespace gamepad { diff --git a/include/history.hpp b/include/history.hpp index 7b1fc3c6..045f6aab 100644 --- a/include/history.hpp +++ b/include/history.hpp @@ -19,8 +19,7 @@ struct CableWidget; } // namespace app -/** Action history for UI undo/redo -*/ +/** Action history for UI undo/redo */ namespace history { diff --git a/include/keyboard.hpp b/include/keyboard.hpp index 49f8bb42..1bd47d99 100644 --- a/include/keyboard.hpp +++ b/include/keyboard.hpp @@ -4,10 +4,7 @@ namespace rack { - - -/** Computer keyboard MIDI driver -*/ +/** Computer keyboard MIDI driver */ namespace keyboard { diff --git a/include/library.hpp b/include/library.hpp index 44e572ce..639ddbec 100644 --- a/include/library.hpp +++ b/include/library.hpp @@ -5,10 +5,7 @@ namespace rack { - - -/** Synchronizes plugins with the VCV Library and handles VCV accounts with the vcvrack.com API -*/ +/** 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 1aedfc48..5f2cf11b 100644 --- a/include/logger.hpp +++ b/include/logger.hpp @@ -16,10 +16,7 @@ will print something like namespace rack { - - -/** Logs messages to a file or the terminal -*/ +/** Logs messages to a file or the terminal */ namespace logger { diff --git a/include/math.hpp b/include/math.hpp index e313b02d..5453c8f3 100644 --- a/include/math.hpp +++ b/include/math.hpp @@ -6,10 +6,7 @@ namespace rack { - - -/** Extends `` with extra functions and types -*/ +/** Extends `` with extra functions and types */ namespace math { diff --git a/include/midi.hpp b/include/midi.hpp index 67421630..81e344e9 100644 --- a/include/midi.hpp +++ b/include/midi.hpp @@ -9,10 +9,7 @@ namespace rack { - - -/** Abstraction for all MIDI drivers in Rack -*/ +/** Abstraction for all MIDI drivers in Rack */ namespace midi { diff --git a/include/network.hpp b/include/network.hpp index 07fc2684..61b6eb93 100644 --- a/include/network.hpp +++ b/include/network.hpp @@ -7,10 +7,7 @@ namespace rack { - - -/** Networking functions for HTTP requests, downloads, and URLs -*/ +/** Networking functions for HTTP requests, downloads, and URLs */ namespace network { diff --git a/include/patch.hpp b/include/patch.hpp index 23e0dbfb..22bb8bde 100644 --- a/include/patch.hpp +++ b/include/patch.hpp @@ -5,6 +5,7 @@ namespace rack { +/** Handles the Rack patch file state */ namespace patch { diff --git a/include/plugin.hpp b/include/plugin.hpp index 81365661..62b225b3 100644 --- a/include/plugin.hpp +++ b/include/plugin.hpp @@ -7,10 +7,7 @@ namespace rack { - - -/** Loads and manages Rack plugins -*/ +/** Loads and manages Rack plugins */ namespace plugin { diff --git a/include/random.hpp b/include/random.hpp index 0108051b..c97bff59 100644 --- a/include/random.hpp +++ b/include/random.hpp @@ -5,10 +5,7 @@ namespace rack { - - -/** Random number generation -*/ +/** Random number generation */ namespace random { diff --git a/include/settings.hpp b/include/settings.hpp index 6e558ad6..09d09f62 100644 --- a/include/settings.hpp +++ b/include/settings.hpp @@ -13,10 +13,7 @@ namespace rack { - - -/** Process-scope globals, most of which are persisted to a file -*/ +/** Process-scope globals, most of which are persisted across launches */ namespace settings { diff --git a/include/string.hpp b/include/string.hpp index 9d347667..29ba0504 100644 --- a/include/string.hpp +++ b/include/string.hpp @@ -6,10 +6,7 @@ namespace rack { - - -/** Supplemental `std::string` functions -*/ +/** Supplemental `std::string` functions */ namespace string { diff --git a/include/system.hpp b/include/system.hpp index 47bfb75b..c8809b97 100644 --- a/include/system.hpp +++ b/include/system.hpp @@ -5,10 +5,7 @@ namespace rack { - - -/** Cross-platform functions for operating system, file path, and filesystem routines -*/ +/** Cross-platform functions for OS, file path, and filesystem routines */ namespace system { diff --git a/include/tag.hpp b/include/tag.hpp index 411fb43d..658ade4d 100644 --- a/include/tag.hpp +++ b/include/tag.hpp @@ -5,8 +5,7 @@ namespace rack { -/** Tags describing the functions of modules -*/ +/** Tags describing the function(s) of modules */ namespace tag { diff --git a/include/weakptr.hpp b/include/weakptr.hpp index a3e6ca9a..f8d3cde1 100644 --- a/include/weakptr.hpp +++ b/include/weakptr.hpp @@ -12,8 +12,7 @@ struct WeakHandle { }; -/** Base class for classes that allow `WeakPtr`s to be used. -*/ +/** Base class for classes that allow `WeakPtr`s to be used. */ struct WeakBase { WeakHandle* weakHandle = nullptr; diff --git a/include/widget/SvgWidget.hpp b/include/widget/SvgWidget.hpp index 5136c756..f80876b5 100644 --- a/include/widget/SvgWidget.hpp +++ b/include/widget/SvgWidget.hpp @@ -6,7 +6,7 @@ namespace rack { namespace widget { -/** Draws an Svg */ +/** Owns and draws a window::Svg */ struct SvgWidget : Widget { std::shared_ptr svg; diff --git a/include/widget/Widget.hpp b/include/widget/Widget.hpp index fdf7f781..f72d0695 100644 --- a/include/widget/Widget.hpp +++ b/include/widget/Widget.hpp @@ -10,10 +10,7 @@ namespace rack { - - -/** Basic UI widget types -*/ +/** Base UI widget types */ namespace widget { @@ -469,7 +466,7 @@ struct Widget : WeakBase { recurseEvent(&Widget::onHide, e); } - /** Occurs after the Window, OpenGL context, and Nanovg are created. + /** Occurs after the Window (including OpenGL and NanoVG contexts) are created. Recurses. */ struct ContextCreateEvent : BaseEvent { @@ -479,7 +476,7 @@ struct Widget : WeakBase { recurseEvent(&Widget::onContextCreate, e); } - /** Occurs before the Window, OpenGL context, and Nanovg are destroyed. + /** Occurs before the Window (including OpenGL and NanoVG contexts) are destroyed. Recurses. */ struct ContextDestroyEvent : BaseEvent { diff --git a/include/window/Svg.hpp b/include/window/Svg.hpp index b57bd84e..4df1646b 100644 --- a/include/window/Svg.hpp +++ b/include/window/Svg.hpp @@ -36,6 +36,7 @@ inline math::Vec mm2px(math::Vec mm) { } +/** Scalable Vector Graphics document */ struct Svg { NSVGimage* handle = NULL;