[Bf-blender-cvs] [0910b76be3c] temp-geometry-nodes-fields--fields: Add a high-level description to the header file

[Hans Goudey]

Commit: 0910b76be3c966d614ddabd3ed37a186dfe4eeb7
Author: Hans Goudey
Date:   Thu Aug 26 15:28:41 2021 -0500
Branches: temp-geometry-nodes-fields--fields
https://developer.blender.org/rB0910b76be3c966d614ddabd3ed37a186dfe4eeb7

Add a high-level description to the header file

===================================================================

M	source/blender/functions/FN_field.hh

===================================================================

diff --git a/source/blender/functions/FN_field.hh b/source/blender/functions/FN_field.hh
index ff38d40e395..16164aabffb 100644
--- a/source/blender/functions/FN_field.hh
+++ b/source/blender/functions/FN_field.hh
@@ -18,6 +18,16 @@
 
 /** \file
  * \ingroup fn
+ *
+ * Field serve as an intermediate representation for a calculation of a group of functions. Having
+ * an intermediate representation is helpful mainly to separate the execution system from the
+ * system that describes the necessary computations. Fields can be executed in different contexts,
+ * and optimization might mean executing the fields differently based on some factors like the
+ * number of elements.
+ *
+ * For now, fields are very tied to the multi-function system, but in the future the #Function
+ * class could be extended to use different descriptions of its outputs and computation besides
+ * the embedded multi-function.
  */
 
 #include "BLI_vector.hh"