Browse Source

Adjust formatting of namespace docs.

tags/v2.0.0
Andrew Belt 3 years ago
parent
commit
6d5a76788f
24 changed files with 27 additions and 75 deletions
  1. +1
    -2
      include/asset.hpp
  2. +1
    -4
      include/audio.hpp
  3. +1
    -3
      include/color.hpp
  4. +1
    -2
      include/common.hpp
  5. +2
    -3
      include/discord.hpp
  6. +1
    -4
      include/gamepad.hpp
  7. +1
    -2
      include/history.hpp
  8. +1
    -4
      include/keyboard.hpp
  9. +1
    -4
      include/library.hpp
  10. +1
    -4
      include/logger.hpp
  11. +1
    -4
      include/math.hpp
  12. +1
    -4
      include/midi.hpp
  13. +1
    -4
      include/network.hpp
  14. +1
    -0
      include/patch.hpp
  15. +1
    -4
      include/plugin.hpp
  16. +1
    -4
      include/random.hpp
  17. +1
    -4
      include/settings.hpp
  18. +1
    -4
      include/string.hpp
  19. +1
    -4
      include/system.hpp
  20. +1
    -2
      include/tag.hpp
  21. +1
    -2
      include/weakptr.hpp
  22. +1
    -1
      include/widget/SvgWidget.hpp
  23. +3
    -6
      include/widget/Widget.hpp
  24. +1
    -0
      include/window/Svg.hpp

+ 1
- 2
include/asset.hpp View File

@@ -15,8 +15,7 @@ struct Module;
} // namespace engine


/** Handles common path locations.
*/
/** Handles common path locations */
namespace asset {




+ 1
- 4
include/audio.hpp View File

@@ -8,10 +8,7 @@
#include <context.hpp>

namespace rack {


/** Abstraction for all audio drivers in Rack
*/
/** Abstraction for all audio drivers in Rack */
namespace audio {




+ 1
- 3
include/color.hpp View File

@@ -6,9 +6,7 @@


namespace rack {

/** Utilities for `NVGcolor`
*/
/** Utilities for `NVGcolor` */
namespace color {




+ 1
- 2
include/common.hpp View File

@@ -161,8 +161,7 @@ namespace std {
#endif


/** Root namespace for the Rack API
*/
/** Root namespace for the Rack API */
namespace rack {




+ 2
- 3
include/discord.hpp View File

@@ -1,10 +1,9 @@
#pragma once
#include <common.hpp>

namespace rack {

/** Updates Discord "now playing" status with IPC
*/
namespace rack {
/** Updates Discord "now playing" status with IPC */
namespace discord {




+ 1
- 4
include/gamepad.hpp View File

@@ -3,10 +3,7 @@


namespace rack {


/** Gamepad/joystick/controller MIDI driver
*/
/** Gamepad/joystick/controller MIDI driver */
namespace gamepad {




+ 1
- 2
include/history.hpp View File

@@ -19,8 +19,7 @@ struct CableWidget;
} // namespace app


/** Action history for UI undo/redo
*/
/** Action history for UI undo/redo */
namespace history {




+ 1
- 4
include/keyboard.hpp View File

@@ -4,10 +4,7 @@


namespace rack {


/** Computer keyboard MIDI driver
*/
/** Computer keyboard MIDI driver */
namespace keyboard {




+ 1
- 4
include/library.hpp View File

@@ -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 {




+ 1
- 4
include/logger.hpp View File

@@ -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 {




+ 1
- 4
include/math.hpp View File

@@ -6,10 +6,7 @@


namespace rack {


/** Extends `<cmath>` with extra functions and types
*/
/** Extends `<cmath>` with extra functions and types */
namespace math {




+ 1
- 4
include/midi.hpp View File

@@ -9,10 +9,7 @@


namespace rack {


/** Abstraction for all MIDI drivers in Rack
*/
/** Abstraction for all MIDI drivers in Rack */
namespace midi {




+ 1
- 4
include/network.hpp View File

@@ -7,10 +7,7 @@


namespace rack {


/** Networking functions for HTTP requests, downloads, and URLs
*/
/** Networking functions for HTTP requests, downloads, and URLs */
namespace network {




+ 1
- 0
include/patch.hpp View File

@@ -5,6 +5,7 @@


namespace rack {
/** Handles the Rack patch file state */
namespace patch {




+ 1
- 4
include/plugin.hpp View File

@@ -7,10 +7,7 @@


namespace rack {


/** Loads and manages Rack plugins
*/
/** Loads and manages Rack plugins */
namespace plugin {




+ 1
- 4
include/random.hpp View File

@@ -5,10 +5,7 @@


namespace rack {


/** Random number generation
*/
/** Random number generation */
namespace random {




+ 1
- 4
include/settings.hpp View File

@@ -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 {




+ 1
- 4
include/string.hpp View File

@@ -6,10 +6,7 @@


namespace rack {


/** Supplemental `std::string` functions
*/
/** Supplemental `std::string` functions */
namespace string {




+ 1
- 4
include/system.hpp View File

@@ -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 {




+ 1
- 2
include/tag.hpp View File

@@ -5,8 +5,7 @@


namespace rack {
/** Tags describing the functions of modules
*/
/** Tags describing the function(s) of modules */
namespace tag {




+ 1
- 2
include/weakptr.hpp View File

@@ -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;



+ 1
- 1
include/widget/SvgWidget.hpp View File

@@ -6,7 +6,7 @@ namespace rack {
namespace widget {


/** Draws an Svg */
/** Owns and draws a window::Svg */
struct SvgWidget : Widget {
std::shared_ptr<window::Svg> svg;



+ 3
- 6
include/widget/Widget.hpp View File

@@ -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 {


+ 1
- 0
include/window/Svg.hpp View File

@@ -36,6 +36,7 @@ inline math::Vec mm2px(math::Vec mm) {
}


/** Scalable Vector Graphics document */
struct Svg {
NSVGimage* handle = NULL;



Loading…
Cancel
Save