senseApis/xcbXorg/xcbXorg.cpp

@@ -11,7 +11,13 @@
 #include <xcb/xcb.h>
 #include "xcbXorg.h"
 
-// Key for identifying unique X server connections
+/**
+ * @brief Manages X server connections using XCB
+ *
+ * This struct manages connections to the X server using the XCB library. It
+ * ensures that each unique display and screen combination has a single
+ * connection, and provides RAII management for these connections.
+ */
 struct XcbConnection
 {
     struct XConnectionIdentifier
@@ -138,6 +144,12 @@ namespace xcb_window_search {
         MatchType matchType);
 }
 
+/**
+ * @brief Represents an attached device and its associated window
+ *
+ * This class represents a device that has been attached to the X server. It
+ * manages the connection to the X server and the window selection criteria.
+ */
 class AttachedDevice
 {
 public:
@@ -433,6 +445,20 @@ static hk::sense_api::SenseApiDesc xcbXorgApiDesc =
     }
 };
 
+/* Below here are the exported functions that Harikoff will use both to load
+ * and use this library.
+ ******************************************************************************/
+
+/**
+ * @brief Get the Sense API Descriptor
+ *
+ * This function is used to retrieve the descriptor for the Sense API provided
+ * by this library. The descriptor contains information about the API, such as
+ * its name, the implexors it exports, and the management operations it
+ * supports.
+ *
+ * @return A reference to the SenseApiDesc structure describing the API.
+ */
 extern HK_UNMANGLED hk::sense_api::getSenseApiDescFn
     HK_GET_SENSE_API_DESC_FN_NAME;