[gnome-commander] noop: Add comment for gnome-cmd-con-smb class

[Uwe Scholz <uwescholz src gnome org>]

commit ef03914712573ff23d53c44b237faffe9715366a
Author: Uwe Scholz <u scholz83 gmx de>
Date:   Sat Dec 11 20:41:45 2021 +0100

    noop: Add comment for gnome-cmd-con-smb class

 src/gnome-cmd-con-smb.h | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)
---
diff --git a/src/gnome-cmd-con-smb.h b/src/gnome-cmd-con-smb.h
index e962cd5c..917dfb8f 100644
--- a/src/gnome-cmd-con-smb.h
+++ b/src/gnome-cmd-con-smb.h
@@ -29,7 +29,13 @@
 #define GNOME_CMD_IS_CON_SMB_CLASS(klass)   (G_TYPE_CHECK_CLASS_TYPE ((klass), GNOME_CMD_TYPE_CON_SMB))
 #define GNOME_CMD_CON_SMB_GET_CLASS(obj)    (G_TYPE_INSTANCE_GET_CLASS((obj), GNOME_CMD_TYPE_CON_SMB, 
GnomeCmdConSmbClass))
 
-
+/**
+ * @brief Class for conecting to samba and show available workgroups
+ *
+ * This class is _not_ meant to be used when connecting to a single samba remote, e.g. to smb://server/share.
+ * Instead, it is used to search workgroups, therefore it will list available workgroubs through the 
connection
+ * to smb:///.
+ */
 struct GnomeCmdConSmb
 {
     GnomeCmdCon parent;