diff options
author | David Robillard <d@drobilla.net> | 2012-05-11 06:05:58 +0000 |
---|---|---|
committer | David Robillard <d@drobilla.net> | 2012-05-11 06:05:58 +0000 |
commit | e5b2164c84d0928ce0765386095064fd946744c2 (patch) | |
tree | 861ad727d953b66f42652da17e607614a3ab7613 /ingen/serialisation | |
parent | e684838068b6f8b37fe130195cdeb3a0f3b17ffd (diff) | |
download | ingen-e5b2164c84d0928ce0765386095064fd946744c2.tar.gz ingen-e5b2164c84d0928ce0765386095064fd946744c2.tar.bz2 ingen-e5b2164c84d0928ce0765386095064fd946744c2.zip |
Generate API documentation.
git-svn-id: http://svn.drobilla.net/lad/trunk/ingen@4352 a436a847-0d15-0410-975c-d299462d15a1
Diffstat (limited to 'ingen/serialisation')
-rw-r--r-- | ingen/serialisation/Parser.hpp | 13 | ||||
-rw-r--r-- | ingen/serialisation/Serialiser.hpp | 17 |
2 files changed, 19 insertions, 11 deletions
diff --git a/ingen/serialisation/Parser.hpp b/ingen/serialisation/Parser.hpp index ceaaa99c..5253a3e4 100644 --- a/ingen/serialisation/Parser.hpp +++ b/ingen/serialisation/Parser.hpp @@ -14,6 +14,10 @@ along with Ingen. If not, see <http://www.gnu.org/licenses/>. */ +/** + @defgroup IngenSerialisation Turtle Serialisation +*/ + #ifndef INGEN_SERIALISATION_PARSER_HPP #define INGEN_SERIALISATION_PARSER_HPP @@ -34,10 +38,11 @@ namespace Shared { class World; } namespace Serialisation { -/** Parse Ingen objects from RDF. - * - * \ingroup IngenSerialisation - */ +/** + Read Ingen objects from Turtle files or strings. + + @ingroup IngenSerialisation +*/ class Parser { public: explicit Parser(Shared::World& world); diff --git a/ingen/serialisation/Serialiser.hpp b/ingen/serialisation/Serialiser.hpp index b09c194a..ab080a3d 100644 --- a/ingen/serialisation/Serialiser.hpp +++ b/ingen/serialisation/Serialiser.hpp @@ -43,10 +43,11 @@ class Store; namespace Serialisation { -/** Serialises Ingen objects (patches, nodes, etc) to RDF. - * - * \ingroup IngenSerialisation - */ +/** + Write Ingen objects to Turtle files or strings. + + @ingroup IngenSerialisation +*/ class Serialiser { public: @@ -67,10 +68,12 @@ public: virtual void start_to_string(const Raul::Path& root, const std::string& base_uri); - virtual void serialise(SharedPtr<const GraphObject> object) throw (std::logic_error); + virtual void serialise(SharedPtr<const GraphObject> object) + throw (std::logic_error); - virtual void serialise_edge(const Sord::Node& parent, - SharedPtr<const Edge> c) throw (std::logic_error); + virtual void serialise_edge(const Sord::Node& parent, + SharedPtr<const Edge> c) + throw (std::logic_error); virtual std::string finish(); |