Browse Source

Fix various doc and source comment typos

Fixes a variety of user- and dev-facing typos.
pull/899/head
luzpaz 1 week ago
parent
commit
716b648e2b
8 changed files with 11 additions and 11 deletions
  1. +2
    -2
      docs/DIFFERENCES.md
  2. +1
    -1
      docs/LICENSES.md
  3. +1
    -1
      docs/OVERVIEW.md
  4. +1
    -1
      plugins/Cardinal/src/AudioFile.cpp
  5. +2
    -2
      plugins/Cardinal/src/Carla.cpp
  6. +2
    -2
      plugins/Cardinal/src/Ildaeil.cpp
  7. +1
    -1
      plugins/Cardinal/src/TextEditor.cpp
  8. +1
    -1
      src/CardinalX11WindowIcon.cpp

+ 2
- 2
docs/DIFFERENCES.md View File

@@ -10,7 +10,7 @@ Also, the official plugin works pretty much like the free standalone where you l
This is intentionally not allowed/enabled in Cardinal, as the target is to make a self-contained plugin binary.
Online access is also not allowed.

Bellow follows a list of features comparing the official plugin to Cardinal.
Below follows a list of features comparing the official plugin to Cardinal.

| Feature | Rack Pro | Cardinal | Additional notes |
|--------------------------------|---------------------------|---------------------------------|------------------|
@@ -36,7 +36,7 @@ Bellow follows a list of features comparing the official plugin to Cardinal.
| FX plugin variant | 16 ins, 16 outs | 2 ins, 2 outs | |
| Raw-CV plugin variant | Unsupported | 8 audio IO + 10 CV IO | Available in JACK, LV2 and VST3 formats, not possible in AU and VST2 |
| Arbitrary parameter automation | Yes | No (*) | Static 24 automatable params, use Host Params/Map modules to map them to module parameters |
| Integrated plugin host | No, Host payed separately | Yes, using Carla or Ildaeil | |
| Integrated plugin host | No, Host paid separately | Yes, using Carla or Ildaeil | |
| Host sync/timing | Using MIDI signals | Using dedicated module | |
| Linux/X11 event handling | Runs on 2nd thread | Runs on main/GUI thread | |
| v1 module compatibility | No | No, but with less restrictions | Module widgets can load resources at any point |


+ 1
- 1
docs/LICENSES.md View File

@@ -99,7 +99,7 @@ Below follows a list of all code licenses used in Cardinal and linked submodules

## ARTWORK / PANEL LICENSES

Bellow follows a list of all licenses related to **artwork and module panels**, sorted by file name.
Below follows a list of all licenses related to **artwork and module panels**, sorted by file name.
Licenses were retrieved from the official project's LICENSE, README or related files.
When * is used, it is meant as wildcard of all files, with potential exceptions mentioned afterwards.
When a license is uncertain, ??? is used.


+ 1
- 1
docs/OVERVIEW.md View File

@@ -45,7 +45,7 @@ Implementing new plugin formats will be done here.
This directory contains special header files needed to build the original Rack code as required by Cardinal.
These headers are included before the official Rack ones, allowing us to override some implementation details.

Additionally a few compatiblity headers are present, helping compile the code for more targets than officially supported in Rack.
Additionally a few compatibility headers are present, helping compile the code for more targets than officially supported in Rack.

## lv2export



+ 1
- 1
plugins/Cardinal/src/AudioFile.cpp View File

@@ -201,7 +201,7 @@ struct CarlaInternalPluginModule : Module, Runner {
{
switch (opcode)
{
// cannnot be supported
// cannot be supported
case NATIVE_HOST_OPCODE_HOST_IDLE:
break;
// other stuff


+ 2
- 2
plugins/Cardinal/src/Carla.cpp View File

@@ -27,7 +27,7 @@
#include "water/xml/XmlDocument.h"

#ifndef CARDINAL_SYSDEPS
// private method that takes ownership, we can use it to avoid superfulous allocations
// private method that takes ownership, we can use it to avoid superfluous allocations
extern "C" {
json_t *jsonp_stringn_nocheck_own(const char* value, size_t len);
}
@@ -244,7 +244,7 @@ struct CarlaModule : Module {
{
switch (opcode)
{
// cannnot be supported
// cannot be supported
case NATIVE_HOST_OPCODE_HOST_IDLE:
break;
// other stuff


+ 2
- 2
plugins/Cardinal/src/Ildaeil.cpp View File

@@ -52,7 +52,7 @@
#include <string>

#ifndef CARDINAL_SYSDEPS
// private method that takes ownership, we can use it to avoid superfulous allocations
// private method that takes ownership, we can use it to avoid superfluous allocations
extern "C" {
json_t *jsonp_stringn_nocheck_own(const char* value, size_t len);
}
@@ -575,7 +575,7 @@ struct IldaeilModule : Module {
{
switch (opcode)
{
// cannnot be supported?
// cannot be supported?
case NATIVE_HOST_OPCODE_HOST_IDLE:
break;
// other stuff


+ 1
- 1
plugins/Cardinal/src/TextEditor.cpp View File

@@ -85,7 +85,7 @@ struct TextEditorModule : Module {
{
file.clear();

// Rack Core Notes compatiblity
// Rack Core Notes compatibility
if (json_t* const textJ = json_object_get(rootJ, "text"))
{
text = json_string_value(textJ);


+ 1
- 1
src/CardinalX11WindowIcon.cpp View File

@@ -1214,7 +1214,7 @@ static constexpr const unsigned long sCardinalX11Icon[] = {

static constexpr const uint32_t sCardinalX11IconSize = 2 + 16 * 16 + 2 + 48 * 48 + 2 + 128 * 128;

// declaration first, ensuring extern/visiblity status is respected
// declaration first, ensuring extern/visibility status is respected
extern const unsigned long* gCardinalX11Icon;

// definition afterwards


Loading…
Cancel
Save