]> sigrok.org Git - libsigrok.git/blobdiff - bindings/cxx/ConfigKey_methods.hpp
C++: Make most constructors explicit
[libsigrok.git] / bindings / cxx / ConfigKey_methods.hpp
index 997a52ee4a3e264c8599e9a654faccab0b571722..f759cc4e3d6be717279a5873cc0d85345452f34b 100644 (file)
@@ -1,5 +1,10 @@
-    const DataType *get_data_type() const;
-    string get_identifier() const;
-    string get_description() const;
-    static const ConfigKey *get(string identifier);
+    /** Data type used for this configuration key. */
+    const DataType *data_type() const;
+    /** String identifier for this configuration key, suitable for CLI use. */
+    string identifier() const;
+    /** Description of this configuration key. */
+    string description() const;
+    /** Get configuration key by string identifier. */
+    static const ConfigKey *get_by_identifier(string identifier);
+    /** Parse a string argument into the appropriate type for this key. */
     Glib::VariantBase parse_string(string value) const;