Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,7 @@ via [The Audio Programmer Discord](https://discord.gg/v5Rs8h6aGF), I'm @Meijis.

## Documentation

Documentation is built automatically, and hosted [here](https://mostly-harmless.pages.dev). For convenience, it also
includes the documentation for marvin.
Documentation is built automatically, and hosted [here](https://mostly-harmless.pages.dev).

## Features

Expand Down
12 changes: 12 additions & 0 deletions docs/mostlyharmless_NamespaceDocs.h
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,12 @@
* \brief The top-level namespace, contains all things plugin-related
*/
namespace mostly_harmless {
/**
* \brief Framework-Developer-Only documentation, for specific mechanisms within the framework
*/
namespace internal {

}
/**
* \brief Contains core functionality of the framework
*/
Expand All @@ -34,6 +40,12 @@ namespace mostly_harmless {
* \brief Contains general purpose utility classes & functions
*/
namespace utils {
/**
* \brief Contains filesystem helpers
*/
namespace directories {

}

}
/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ namespace mostly_harmless::data {
*
* The database schema itself is fairly generic, a single `DATA` table, with `NAME`, `TEXT_VALUE`, `BOOL_VALUE`, `INT_VALUE`, `FLOAT_VALUE` and `DOUBLE_VALUE fields.
* get and set are templated, and will get or set the field associated with the given template type - so it's important to ensure you retrieve the correct value type for a field you've previously set.
* The fields default to `""`, `false`, `0`, `0.0f` and `0.0` respectively.
* The fields default to "", false, 0, 0.0f and 0.0 respectively.
* The connection is set to WAL mode, to allow concurrent access.
*/
class DatabaseState final {
Expand Down