Browse Source

Improve namespace documentation.

tags/v2.0.0
Andrew Belt 3 years ago
parent
commit
4e8b9ef301
25 changed files with 40 additions and 32 deletions
  1. +2
    -3
      docs/index.md
  2. BIN
      docs/logo.png
  3. +1
    -1
      include/app/common.hpp
  4. +2
    -0
      include/asset.hpp
  5. +1
    -1
      include/audio.hpp
  6. +5
    -2
      include/common.hpp
  7. +2
    -7
      include/componentlibrary.hpp
  8. +2
    -1
      include/context.hpp
  9. +1
    -1
      include/discord.hpp
  10. +1
    -1
      include/dsp/common.hpp
  11. +2
    -0
      include/engine/Engine.hpp
  12. +2
    -1
      include/history.hpp
  13. +1
    -1
      include/library.hpp
  14. +1
    -1
      include/logger.hpp
  15. +1
    -1
      include/math.hpp
  16. +1
    -1
      include/midi.hpp
  17. +1
    -1
      include/network.hpp
  18. +1
    -1
      include/plugin.hpp
  19. +2
    -2
      include/random.hpp
  20. +2
    -1
      include/settings.hpp
  21. +2
    -1
      include/simd/vector.hpp
  22. +1
    -1
      include/system.hpp
  23. +2
    -0
      include/tag.hpp
  24. +1
    -1
      include/ui/common.hpp
  25. +3
    -2
      include/widget/Widget.hpp

+ 2
- 3
docs/index.md View File

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

BIN
docs/logo.png View File

Before After
Width: 55  |  Height: 55  |  Size: 1.5KB Width: 55  |  Height: 55  |  Size: 1.8KB

+ 1
- 1
include/app/common.hpp View File

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



+ 2
- 0
include/asset.hpp View File

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


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




+ 1
- 1
include/audio.hpp View File

@@ -10,7 +10,7 @@
namespace rack {


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



+ 5
- 2
include/common.hpp View File

@@ -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(...);


+ 2
- 7
include/componentlibrary.hpp View File

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



+ 2
- 1
include/context.hpp View File

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


+ 1
- 1
include/discord.hpp View File

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

namespace rack {

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



+ 1
- 1
include/dsp/common.hpp View File

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


/** Digital signal processing routines
/** Digital signal processing routines and classes
*/
namespace dsp {



+ 2
- 0
include/engine/Engine.hpp View File

@@ -8,6 +8,8 @@


namespace rack {
/** High-performance classes handling modules and voltage signals between them
*/
namespace engine {




+ 2
- 1
include/history.hpp View File

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


/** Undo history actions for the Rack application */
/** Action history for UI undo/redo
*/
namespace history {




+ 1
- 1
include/library.hpp View File

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



+ 1
- 1
include/logger.hpp View File

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



+ 1
- 1
include/math.hpp View File

@@ -8,7 +8,7 @@
namespace rack {


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



+ 1
- 1
include/midi.hpp View File

@@ -11,7 +11,7 @@
namespace rack {


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



+ 1
- 1
include/network.hpp View File

@@ -9,7 +9,7 @@
namespace rack {


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



+ 1
- 1
include/plugin.hpp View File

@@ -9,7 +9,7 @@
namespace rack {


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



+ 2
- 2
include/random.hpp View File

@@ -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).


+ 2
- 1
include/settings.hpp View File

@@ -15,7 +15,8 @@
namespace rack {


/** Process-level globals. */
/** Process-scope globals, most of which are persisted to a file
*/
namespace settings {




+ 2
- 1
include/simd/vector.hpp View File

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


/** Abstraction of byte-aligned values for SIMD CPU acceleration. */
/** Abstraction of aligned types for SIMD computation
*/
namespace simd {




+ 1
- 1
include/system.hpp View File

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



+ 2
- 0
include/tag.hpp View File

@@ -5,6 +5,8 @@


namespace rack {
/** Tags describing the functions of modules
*/
namespace tag {




+ 1
- 1
include/ui/common.hpp View File

@@ -16,7 +16,7 @@
namespace rack {


/** General user interface widgets using Blendish
/** Common graphical user interface widgets
*/
namespace ui {



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

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

Loading…
Cancel
Save