qt: clarify prefs tree construction documentation

with respect to plugin vs. module.

before we adjust it in the next commit.

modules/gui/qt/dialogs/preferences/complete_preferences.cpp

@@ -85,7 +85,7 @@ PrefsTree::PrefsTree( qt_intf_t *_p_intf, QWidget *_parent,
     unsigned confsize;
     module_config_t *const p_config = module_config_get (p_module, &confsize);
 
-    /* Go through the list of conf */
+    /* Go through the list of core conf to build the base tree */
     for( size_t i = 0; i < confsize; i++ )
     {
         QIcon icon;
@@ -480,8 +480,8 @@ PrefsItemData::PrefsItemData( QObject *_parent ) : QObject( _parent )
     b_loaded = false;
 }
 
-/* go over the module config items and search text in psz_text
- * also search the module name and head */
+/* go over the config items and search text in psz_text
+ * also search the node name and head */
 bool PrefsItemData::contains( const QString &text, Qt::CaseSensitivity cs )
 {
     if( this->i_type == TYPE_CATEGORY )
@@ -521,7 +521,7 @@ bool PrefsItemData::contains( const QString &text, Qt::CaseSensitivity cs )
         return true;
     }
 
-    /* check options belonging to this subcat or module */
+    /* check options belonging to this core subcat or plugin */
 
     unsigned confsize;
     module_config_t *const p_config = module_config_get (p_module, &confsize),
@@ -558,8 +558,8 @@ bool PrefsItemData::contains( const QString &text, Qt::CaseSensitivity cs )
             /* for core, if we hit a cat or subcat, stop */
             if ( is_core )
                 break;
-            /* a module's options are grouped under one node; we can/should
-               ignore all cat/subcat entries. */
+            /* a plugin's options are grouped under one node; we can/should
+               ignore all other cat/subcat entries. */
             continue;
         }
 

modules/gui/qt/dialogs/preferences/complete_preferences.hpp

@@ -43,14 +43,15 @@
  * 2) Certain subcats ('general' type) are not given a node under their cat,
  *    they represent the top level cat's option panel itself (otherwise cat
  *    entries would just have empty panels).
- * 3) Other modules (currently) have their options located under a single tree
+ * 3) Plugins (currently) have their option sets located under a single tree
  *    node attached to one of the core cat/subcat nodes. The location for this
- *    is chosen based upon the first cat and subcat encountered in the module's
- *    option set. (If the subcat does not belong to the cat, then the node is
- *    attached directly to the cat; If the module's option set has options
- *    before the cat/subcat hint entries, this does not matter; If no cat or
- *    subcat hint is provided in the option set, then no node is created (i.e.
- *    that module's options will not be available in the prefs GUI).
+ *    is chosen based upon the first cat and subcat encountered in the plugin's
+ *    option set (others are ignored). (If due to a mistake the subcat does not
+ *    belong to the cat, then the node is attached directly to the cat node just
+ *    as if the cat's general subcat had been specified; If the plugin's option
+ *    set has options before the cat/subcat hint entries, this does not matter;
+ *    If no cat or subcat hint is provided in the option set, then no node is
+ *    created (i.e. that plugins's options will not be shown).
  */
 
 class AdvPrefsPanel;