Cleanup: move public doc-strings into headers for 'editors'

Ref T92709

1 files changed, 12 insertions, 0 deletions

diff --git a/source/blender/editors/asset/ED_asset_filter.h b/source/blender/editors/asset/ED_asset_filter.h
index 340c4c9dbe7..de18b5fff1e 100644
--- a/source/blender/editors/asset/ED_asset_filter.h
+++ b/source/blender/editors/asset/ED_asset_filter.h
@@ -27,6 +27,18 @@ extern "C" {
 struct AssetFilterSettings;
 struct AssetHandle;
 
+/**
+ * Compare \a asset against the settings of \a filter.
+ *
+ * Individual filter parameters are ORed with the asset properties. That means:
+ * * The asset type must be one of the ID types filtered by, and
+ * * The asset must contain at least one of the tags filtered by.
+ * However for an asset to be matching it must have one match in each of the parameters. I.e. one
+ * matching type __and__ at least one matching tag.
+ *
+ * \returns True if the asset should be visible with these filter settings (parameters match).
+ * Otherwise returns false (mismatch).
+ */
 bool ED_asset_filter_matches_asset(const struct AssetFilterSettings *filter,
                                    const struct AssetHandle *asset);