diff options
| author | David Robillard <d@drobilla.net> | 2016-10-14 14:32:24 -0400 |
|---|---|---|
| committer | David Robillard <d@drobilla.net> | 2016-10-14 16:27:16 -0400 |
| commit | c16ad68648812a8c4eb90e8666764959b166ac13 (patch) | |
| tree | f88ed10797020257096531f44dc91036795175b5 /ingen | |
| parent | 13cc88d9068ba025acaa923b7a5d410880d9063a (diff) | |
| download | ingen-c16ad68648812a8c4eb90e8666764959b166ac13.tar.gz ingen-c16ad68648812a8c4eb90e8666764959b166ac13.tar.bz2 ingen-c16ad68648812a8c4eb90e8666764959b166ac13.zip | |
Improve documentation
Diffstat (limited to 'ingen')
| -rw-r--r-- | ingen/AtomSink.hpp | 1 | ||||
| -rw-r--r-- | ingen/EngineBase.hpp | 2 | ||||
| -rw-r--r-- | ingen/Interface.hpp | 3 | ||||
| -rw-r--r-- | ingen/Node.hpp | 2 | ||||
| -rw-r--r-- | ingen/Parser.hpp | 2 | ||||
| -rw-r--r-- | ingen/Resource.hpp | 6 | ||||
| -rw-r--r-- | ingen/Serialiser.hpp | 2 |
7 files changed, 11 insertions, 7 deletions
diff --git a/ingen/AtomSink.hpp b/ingen/AtomSink.hpp index 8228001e..d5fe775c 100644 --- a/ingen/AtomSink.hpp +++ b/ingen/AtomSink.hpp @@ -31,6 +31,7 @@ public: /** Write an Atom to the sink. * + * @param msg The atom to write. * @param default_id The default response ID to use if no * patch:sequenceNumber property is present on the message. * diff --git a/ingen/EngineBase.hpp b/ingen/EngineBase.hpp index 7ba4467a..087189e4 100644 --- a/ingen/EngineBase.hpp +++ b/ingen/EngineBase.hpp @@ -28,7 +28,7 @@ namespace Ingen { class Interface; /** - The engine which executes the process graph. + The audio engine which executes the graph. @ingroup Ingen */ diff --git a/ingen/Interface.hpp b/ingen/Interface.hpp index a1a93c06..8a79f269 100644 --- a/ingen/Interface.hpp +++ b/ingen/Interface.hpp @@ -37,8 +37,7 @@ class URI; namespace Ingen { -/** Abstract interface common to both engine and clients. - * Purely virtual (except for the destructor). +/** Abstract interface for Ingen servers and clients. * * @ingroup Ingen */ diff --git a/ingen/Node.hpp b/ingen/Node.hpp index d6253cc4..72c0b3cb 100644 --- a/ingen/Node.hpp +++ b/ingen/Node.hpp @@ -34,7 +34,7 @@ namespace Ingen { class Arc; class Store; -/** An object on the audio graph. +/** A node in the audio graph. * * The key property of nodes is that all nodes have a path and a symbol, as * well as a URI. diff --git a/ingen/Parser.hpp b/ingen/Parser.hpp index 050ddb5a..d6065e59 100644 --- a/ingen/Parser.hpp +++ b/ingen/Parser.hpp @@ -34,7 +34,7 @@ class Interface; class World; /** - Read Ingen objects from Turtle files or strings. + Parser for reading graphs from Turtle files or strings. @ingroup Ingen */ diff --git a/ingen/Resource.hpp b/ingen/Resource.hpp index 604428ce..39452522 100644 --- a/ingen/Resource.hpp +++ b/ingen/Resource.hpp @@ -28,7 +28,11 @@ namespace Ingen { -/** An object with a URI described by properties. +/** A resource with a URI described by properties. + * + * This is the base class for most things in Ingen, including graphs, blocks, + * ports, and the engine itself. + * * @ingroup Ingen */ class INGEN_API Resource : public Raul::Deletable diff --git a/ingen/Serialiser.hpp b/ingen/Serialiser.hpp index b02cd070..e1a62f6e 100644 --- a/ingen/Serialiser.hpp +++ b/ingen/Serialiser.hpp @@ -33,7 +33,7 @@ class Store; class World; /** - Write Ingen objects to Turtle files or strings. + Serialiser for writing graphs to Turtle files or strings. @ingroup Ingen */ |