From: Lars Op den Kamp <lars@opdenkamp.eu>
Date: Tue, 2 Oct 2012 11:07:09 +0000 (+0200)
Subject: more missing docs
X-Git-Tag: upstream/2.2.0~1^2~17^2^2~54
X-Git-Url: https://git.piment-noir.org/?a=commitdiff_plain;h=1c7cd8f8c8085141c4267680a9bdab1d820056bb;p=deb_libcec.git

more missing docs
---

diff --git a/src/LibCecSharp/CecSharpTypes.h b/src/LibCecSharp/CecSharpTypes.h
index adef54d..a0110ad 100644
--- a/src/LibCecSharp/CecSharpTypes.h
+++ b/src/LibCecSharp/CecSharpTypes.h
@@ -39,6 +39,10 @@
 
 #using <System.dll>
 
+/// <summary>
+/// LibCecSharp namespace
+/// </summary>
+/// <see cref="LibCecSharp" />
 namespace CecSharp
 {
   /// <summary>
@@ -425,7 +429,7 @@ namespace CecSharp
 
   /// <summary>
   /// User control code, the key code when the user presses or releases a button on the remote.
-  /// Used by SendKeypress() and the CecKeyPress() callback.
+  /// Used by SendKeypress() and the CecKey callback.
   /// </summary>
   public enum class CecUserControlCode
   {
@@ -2026,14 +2030,34 @@ namespace CecSharp
   }
 
 #pragma managed
-  // delegates for the unmanaged callback methods
+  /// <summary>
+  /// Delegate method for the CecLogMessageCB callback in CecCallbackMethods
+  /// </summary>
   public delegate int  CecLogMessageManagedDelegate(const CEC::cec_log_message &);
+  /// <summary>
+  /// Delegate method for the CecKeyPressCB callback in CecCallbackMethods
+  /// </summary>
   public delegate int  CecKeyPressManagedDelegate(const CEC::cec_keypress &);
+  /// <summary>
+  /// Delegate method for the CecCommandCB callback in CecCallbackMethods
+  /// </summary>
   public delegate int  CecCommandManagedDelegate(const CEC::cec_command &);
+  /// <summary>
+  /// Delegate method for the CecConfigCB callback in CecCallbackMethods
+  /// </summary>
   public delegate int  CecConfigManagedDelegate(const CEC::libcec_configuration &);
+  /// <summary>
+  /// Delegate method for the CecAlertCB callback in CecCallbackMethods
+  /// </summary>
   public delegate int  CecAlertManagedDelegate(const CEC::libcec_alert, const CEC::libcec_parameter &);
-  public delegate int  CecMenuManagedDelegate(const CEC::cec_menu_state newVal);
-  public delegate void CecSourceActivatedManagedDelegate(const CEC::cec_logical_address logicalAddress, const uint8_t bActivated);
+  /// <summary>
+  /// Delegate method for the CecMenuCB callback in CecCallbackMethods
+  /// </summary>
+  public delegate int  CecMenuManagedDelegate(const CEC::cec_menu_state);
+  /// <summary>
+  /// Delegate method for the CecSourceActivatedCB callback in CecCallbackMethods
+  /// </summary>
+  public delegate void CecSourceActivatedManagedDelegate(const CEC::cec_logical_address, const uint8_t);
 
   /// <summary>
   /// Assign the callback methods in the g_cecCallbacks struct