libyang REFACTOR comments

Author: Roytak

src/context.h

@@ -461,7 +461,7 @@ LIBYANG_API_DECL void ly_ctx_set_module_imp_clb(struct ly_ctx *ctx, ly_module_im
  *
  * @param[in] ext Compiled extension instance.
  * @param[in] parent Data parent node instance of a schema node with @p ext instance. In special cases
- * (when not working with data) it be NULL!
+ * (when not working with data) it can be NULL!
  * @param[in] user_data User-supplied callback data.
  * @param[out] ext_data Provided extension instance data.
  * @param[out] ext_data_free Whether the extension instance should free @p ext_data or not.

src/plugins.c

@@ -129,6 +129,8 @@ struct lyplg_record {
 #ifndef STATIC
 static struct ly_set plugins_handlers;
 #endif
+
+/* global sets of loaded plugins */
 struct ly_set ly_plugins_types;
 struct ly_set ly_plugins_extensions;
 

src/tree_schema.h

@@ -1278,7 +1278,7 @@ struct lysc_must {
 struct lysc_type {
     const char *name;                /**< referenced typedef name (without prefix, if any), NULL for built-in types */
     struct lysc_ext_instance *exts;  /**< list of the extension instances ([sized array](@ref sizedarrays)) */
-    uintptr_t plugin_ref;            /**< reference to type plugin, use ::lysc_get_ext_plugin() to get the plugin */
+    uintptr_t plugin_ref;            /**< reference to type plugin, use ::lysc_get_type_plugin() to get the plugin */
     LY_DATA_TYPE basetype;           /**< base type of the type */
     uint32_t refcount;               /**< reference counter for type sharing, it may be accessed concurrently when
                                           creating/freeing data node values that reference it (instance-identifier) */
@@ -1287,7 +1287,7 @@ struct lysc_type {
 struct lysc_type_num {
     const char *name;                /**< referenced typedef name (without prefix, if any), NULL for built-in types */
     struct lysc_ext_instance *exts;  /**< list of the extension instances ([sized array](@ref sizedarrays)) */
-    uintptr_t plugin_ref;            /**< reference to type plugin, use ::lysc_get_ext_plugin() to get the plugin */
+    uintptr_t plugin_ref;            /**< reference to type plugin, use ::lysc_get_type_plugin() to get the plugin */
     LY_DATA_TYPE basetype;           /**< base type of the type */
     uint32_t refcount;               /**< reference counter for type sharing */
 
@@ -1297,7 +1297,7 @@ struct lysc_type_num {
 struct lysc_type_dec {
     const char *name;                /**< referenced typedef name (without prefix, if any), NULL for built-in types */
     struct lysc_ext_instance *exts;  /**< list of the extension instances ([sized array](@ref sizedarrays)) */
-    uintptr_t plugin_ref;            /**< reference to type plugin, use ::lysc_get_ext_plugin() to get the plugin */
+    uintptr_t plugin_ref;            /**< reference to type plugin, use ::lysc_get_type_plugin() to get the plugin */
     LY_DATA_TYPE basetype;           /**< base type of the type */
     uint32_t refcount;               /**< reference counter for type sharing */
 
@@ -1308,7 +1308,7 @@ struct lysc_type_dec {
 struct lysc_type_str {
     const char *name;                /**< referenced typedef name (without prefix, if any), NULL for built-in types */
     struct lysc_ext_instance *exts;  /**< list of the extension instances ([sized array](@ref sizedarrays)) */
-    uintptr_t plugin_ref;            /**< reference to type plugin, use ::lysc_get_ext_plugin() to get the plugin */
+    uintptr_t plugin_ref;            /**< reference to type plugin, use ::lysc_get_type_plugin() to get the plugin */
     LY_DATA_TYPE basetype;           /**< base type of the type */
     uint32_t refcount;               /**< reference counter for type sharing */
 
@@ -1333,7 +1333,7 @@ struct lysc_type_bitenum_item {
 struct lysc_type_enum {
     const char *name;                /**< referenced typedef name (without prefix, if any), NULL for built-in types */
     struct lysc_ext_instance *exts;  /**< list of the extension instances ([sized array](@ref sizedarrays)) */
-    uintptr_t plugin_ref;            /**< reference to type plugin, use ::lysc_get_ext_plugin() to get the plugin */
+    uintptr_t plugin_ref;            /**< reference to type plugin, use ::lysc_get_type_plugin() to get the plugin */
     LY_DATA_TYPE basetype;           /**< base type of the type */
     uint32_t refcount;               /**< reference counter for type sharing */
 
@@ -1343,7 +1343,7 @@ struct lysc_type_enum {
 struct lysc_type_bits {
     const char *name;                /**< referenced typedef name (without prefix, if any), NULL for built-in types */
     struct lysc_ext_instance *exts;  /**< list of the extension instances ([sized array](@ref sizedarrays)) */
-    uintptr_t plugin_ref;            /**< reference to type plugin, use ::lysc_get_ext_plugin() to get the plugin */
+    uintptr_t plugin_ref;            /**< reference to type plugin, use ::lysc_get_type_plugin() to get the plugin */
     LY_DATA_TYPE basetype;           /**< base type of the type */
     uint32_t refcount;               /**< reference counter for type sharing */
 
@@ -1354,7 +1354,7 @@ struct lysc_type_bits {
 struct lysc_type_leafref {
     const char *name;                /**< referenced typedef name (without prefix, if any), NULL for built-in types */
     struct lysc_ext_instance *exts;  /**< list of the extension instances ([sized array](@ref sizedarrays)) */
-    uintptr_t plugin_ref;            /**< reference to type plugin, use ::lysc_get_ext_plugin() to get the plugin */
+    uintptr_t plugin_ref;            /**< reference to type plugin, use ::lysc_get_type_plugin() to get the plugin */
     LY_DATA_TYPE basetype;           /**< base type of the type */
     uint32_t refcount;               /**< reference counter for type sharing */
 
@@ -1367,7 +1367,7 @@ struct lysc_type_leafref {
 struct lysc_type_identityref {
     const char *name;                /**< referenced typedef name (without prefix, if any), NULL for built-in types */
     struct lysc_ext_instance *exts;  /**< list of the extension instances ([sized array](@ref sizedarrays)) */
-    uintptr_t plugin_ref;            /**< reference to type plugin, use ::lysc_get_ext_plugin() to get the plugin */
+    uintptr_t plugin_ref;            /**< reference to type plugin, use ::lysc_get_type_plugin() to get the plugin */
     LY_DATA_TYPE basetype;           /**< base type of the type */
     uint32_t refcount;               /**< reference counter for type sharing */
 
@@ -1378,7 +1378,7 @@ struct lysc_type_identityref {
 struct lysc_type_instanceid {
     const char *name;                /**< referenced typedef name (without prefix, if any), NULL for built-in types */
     struct lysc_ext_instance *exts;  /**< list of the extension instances ([sized array](@ref sizedarrays)) */
-    uintptr_t plugin_ref;            /**< reference to type plugin, use ::lysc_get_ext_plugin() to get the plugin */
+    uintptr_t plugin_ref;            /**< reference to type plugin, use ::lysc_get_type_plugin() to get the plugin */
     LY_DATA_TYPE basetype;           /**< base type of the type */
     uint32_t refcount;               /**< reference counter for type sharing */
 
@@ -1388,7 +1388,7 @@ struct lysc_type_instanceid {
 struct lysc_type_union {
     const char *name;                /**< referenced typedef name (without prefix, if any), NULL for built-in types */
     struct lysc_ext_instance *exts;  /**< list of the extension instances ([sized array](@ref sizedarrays)) */
-    uintptr_t plugin_ref;            /**< reference to type plugin, use ::lysc_get_ext_plugin() to get the plugin */
+    uintptr_t plugin_ref;            /**< reference to type plugin, use ::lysc_get_type_plugin() to get the plugin */
     LY_DATA_TYPE basetype;           /**< base type of the type */
     uint32_t refcount;               /**< reference counter for type sharing */
 
@@ -1398,7 +1398,7 @@ struct lysc_type_union {
 struct lysc_type_bin {
     const char *name;                /**< referenced typedef name (without prefix, if any), NULL for built-in types */
     struct lysc_ext_instance *exts;  /**< list of the extension instances ([sized array](@ref sizedarrays)) */
-    uintptr_t plugin_ref;            /**< reference to type plugin, use ::lysc_get_ext_plugin() to get the plugin */
+    uintptr_t plugin_ref;            /**< reference to type plugin, use ::lysc_get_type_plugin() to get the plugin */
     LY_DATA_TYPE basetype;           /**< base type of the type */
     uint32_t refcount;               /**< reference counter for type sharing */
 

src/tree_schema_internal.h

@@ -185,9 +185,10 @@ struct lysp_yin_ctx {
  * @brief Internal pattern hash table record.
  */
 struct ly_pattern_ht_rec {
-    const char *pattern;            /**< Pattern string, used both as key and for comparison. */
-    uint8_t *serialized_pattern;    /**< Serialized pattern code for this pattern,
-                                         can be deserialized to pcre2_code that can be used directly. */
+    const char *pattern;            /**< Pattern string, used both as key to hash and value to search for. */
+    uint8_t *serialized_pattern;    /**< Serialized pattern code for this pattern.
+                                         Can be deserialized to a compiled pcre2_code that can be used directly,
+                                         see ::ly_pcode_deserialize(). */
 };
 
 /**

tools/lint/common.h

@@ -122,7 +122,7 @@ const struct lysc_node *find_schema_path(const struct ly_ctx *ctx, const char *s
  * @brief General callback providing run-time extension instance data.
  *
  * @param[in] ext Compiled extension instance.
- * @param[in] parent Data aprent, unused.
+ * @param[in] parent Data parent, unused.
  * @param[in] user_data User-supplied callback data.
  * @param[out] ext_data Provided extension instance data.
  * @param[out] ext_data_free Whether the extension instance should free @p ext_data or not.