[Libosinfo] [PATCHv2 2/4] Add osinfo_product_foreach_related() documentation

[Christophe Fergeau]

It's not exported, but API doc never hurts.
---
 osinfo/osinfo_product.c | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/osinfo/osinfo_product.c b/osinfo/osinfo_product.c
index 561da63..f81212d 100644
--- a/osinfo/osinfo_product.c
+++ b/osinfo/osinfo_product.c
@@ -379,6 +379,18 @@ static OsinfoList *osinfo_list_append(OsinfoList *appendee,
     return result;
 }
 
+/**
+ * osinfo_product_foreach_related:
+ * @product: a product
+ * @flags: bitwise-or of #OsinfoProductForeachFlag
+ * @foreach_func: the function to call for each related product
+ * @user_data: user data to pass to foreach_func()
+ *
+ * Call @foreach_func for @product and for each #OsinfoProduct related
+ * to @product. The meaning of 'related' is defined by the @flag parameter,
+ * and can be products @product derives from or products which @product
+ * upgrades or clones, or a combination of these, or none.
+ */
 void osinfo_product_foreach_related(OsinfoProduct *product,
                                     OsinfoProductForeachFlag flags,
                                     OsinfoProductForeach foreach_func,
-- 
1.8.1.4