[krita/rempt/bug-392190] plugins/paintops/libpaintop: Add documentation about our tangle of paintop option options...

[Boudewijn Rempt]

Git commit 4eb2ffeea97606255c14ed1fcf52003d506c92ff by Boudewijn Rempt.
Committed on 15/05/2018 at 12:03.
Pushed by rempt into branch 'rempt/bug-392190'.

Add documentation about our tangle of paintop option options...

CCMAIL:kimageshop at kde.org

M  +20   -0    plugins/paintops/libpaintop/Mainpage.dox

https://commits.kde.org/krita/4eb2ffeea97606255c14ed1fcf52003d506c92ff

diff --git a/plugins/paintops/libpaintop/Mainpage.dox b/plugins/paintops/libpaintop/Mainpage.dox
index 2c103102d3c..e6e1ce5a1bc 100644
--- a/plugins/paintops/libpaintop/Mainpage.dox
+++ b/plugins/paintops/libpaintop/Mainpage.dox
@@ -29,5 +29,25 @@ option provides a graphical view for editing that option (as a page
 in an option popup) and possible also the code necessary for applying
 the effects of that option to the paint device as part of painting.
 
+The following classes are important:
+
+<ul>
+<li>KisPaintOp: this is the engine for a certain kind of brush. It will
+ be created in non-gui threads and keeps its state in a KisPaintOpSettings
+ object.
+<li>KisPaintOpSettings: this is a KisPropertiesConfiguration subclass that
+ stores the settings for all the options that make up a paintop.
+<li>Classes derived from KisPaintOpOption. These classes create a configuration
+  widget. That means that you cannot construct any those objects in a
+  KisPaintOp. KisPaintOps are created in non-gui threads.
+<li>Classes derived from KisCurveOption.KisCurveOption classes have a generic GUI widget,
+  KisCurveOptionWidget. So, in contrast to KisPaintOpOption classes, KisCurveOption
+  instances can and will be created in the constructor of KisPaintOp paintops.
+  This class can manage to read and write its settings directly.
+<li>Classes derived from KisPaintopPropertiesBase. These classes are non-gui,
+  and can read and write KisPropertiesConfiguration objects created by
+  KisPaintOpOption.
+</ul>
+
 */
 // DOXYGEN_SET_IGNORE_PREFIX = Kis Ko K