summaryrefslogtreecommitdiffstats
path: root/include
diff options
context:
space:
mode:
authorDavid Robillard <d@drobilla.net>2025-02-09 18:38:04 -0500
committerDavid Robillard <d@drobilla.net>2025-02-10 16:07:44 -0500
commit8b50a27c323c0a8327c90cc139a6005486e8b834 (patch)
tree2bc29fe5011c9a47fcc190ee19b1c81309de0452 /include
parent2834ac957f73b9cc105ec62e981a292d677af19d (diff)
downloadingen-8b50a27c323c0a8327c90cc139a6005486e8b834.tar.gz
ingen-8b50a27c323c0a8327c90cc139a6005486e8b834.tar.bz2
ingen-8b50a27c323c0a8327c90cc139a6005486e8b834.zip
Fix doc comment syntax and strict clang build
A description here is now required by -Wdocumentation in clang 19.
Diffstat (limited to 'include')
-rw-r--r--include/ingen/Configuration.hpp2
-rw-r--r--include/ingen/Serialiser.hpp4
2 files changed, 3 insertions, 3 deletions
diff --git a/include/ingen/Configuration.hpp b/include/ingen/Configuration.hpp
index 4a7168b1..5c4d2841 100644
--- a/include/ingen/Configuration.hpp
+++ b/include/ingen/Configuration.hpp
@@ -82,7 +82,7 @@ public:
/** Parse a command line.
*
- * @throw OptionError
+ * @throw OptionError An option is unknown or an option value is invalid.
*/
void parse(int argc, char **argv);
diff --git a/include/ingen/Serialiser.hpp b/include/ingen/Serialiser.hpp
index 72941866..6e9d6ad4 100644
--- a/include/ingen/Serialiser.hpp
+++ b/include/ingen/Serialiser.hpp
@@ -77,14 +77,14 @@ public:
/** Serialize an object (graph, block, or port).
*
- * @throw std::logic_error
+ * @throw std::logic_error A serialization hasn't been started.
*/
virtual void serialise(const std::shared_ptr<const Node>& object,
Property::Graph context = Property::Graph::DEFAULT);
/** Serialize an arc.
*
- * @throw std::logic_error
+ * @throw std::logic_error A serialization hasn't been started.
*/
virtual void serialise_arc(const Sord::Node& parent,
const std::shared_ptr<const Arc>& arc);