Changeset 3016 for trunk/sources/HeuristicLab.Persistence/3.3/Default/CompositeSerializers/Storable/StorableHookAttribute.cs

Timestamp:

03/14/10 00:42:28 (14 years ago)

Author:

epitzer

Message:

Update API docs. (#548)

File:

• trunk/sources/HeuristicLab.Persistence/3.3/Default/CompositeSerializers/Storable/StorableHookAttribute.cs (modified) (4 diffs)

trunk/sources/HeuristicLab.Persistence/3.3/Default/CompositeSerializers/Storable/StorableHookAttribute.cs

@@ -16 +16 @@
   /// <summary>
   /// Mark methods that should be called at certain times during
-  /// serialization/deserialization by the <code>StorableSerializer</code>.
+  /// serialization/deserialization by the <c>StorableSerializer</c>.
   /// </summary>
   [AttributeUsage(AttributeTargets.Method, Inherited = false, AllowMultiple = true)]
@@ -32 +32 @@
 
     private readonly HookType hookType;
+    /// <summary>
+    /// Gets the type of the hook.
+    /// </summary>
+    /// <value>The type of the hook.</value>
     public HookType HookType {
       get { return hookType; }
@@ -38 +42 @@
 
     /// <summary>
-    /// Mark method as <code>StorableSerializer</code> hook to be run
-    /// at the <code>HookType</code> time.
+    /// Mark method as <c>StorableSerializer</c> hook to be run
+    /// at the <c>HookType</c> time.
     /// </summary>
-    /// <param name="hookType"></param>
+    /// <param name="hookType">Type of the hook.</param>
     public StorableHookAttribute(HookType hookType) {
       this.hookType = hookType;
@@ -56 +60 @@
 
     /// <summary>
-    /// Invoke <code>hookType</code> hook on <code>obj</code>.
-    /// </summary>    
+    /// Invoke <c>hookType</c> hook on <c>obj</c>.
+    /// </summary>
+    /// <param name="hookType">Type of the hook.</param>
+    /// <param name="obj">The object.</param>
     public static void InvokeHook(HookType hookType, object obj) {
       if (obj == null)