Address PR review comments, add XML docs about DEBUG

Author: bclothier

Rubberduck.Core/UI/Command/MenuItems/CommandBars/SerializeProjectsCommandMenuItem.cs

@@ -66,7 +66,7 @@ protected override void OnExecute(object parameter)
                         if (!toSerialize.ContainsKey(type.Guid))
                         {
                             toSerialize.Add(type.Guid, type);
-                        }                      
+                        }
                     }
                 }
             }
@@ -78,8 +78,12 @@ protected override void OnExecute(object parameter)
             }
 
 #if DEBUG
-            //Dumb hack cos I'm too lazy to wire up another button...
-            var traceDirectory = Path.Combine(Path.GetDirectoryName(_serializationProvider.Target), "COM Trace");
+            //This block must be inside a DEBUG block because the Serialize method 
+            //called is conditionally compiled and available only for a DEBUG build.
+            var path = string.IsNullOrWhiteSpace(_serializationProvider.Target)
+                ? Path.GetDirectoryName(_serializationProvider.Target)
+                : Path.GetTempPath();
+            var traceDirectory = Path.Combine(path, "COM Trace");
             if (!Directory.Exists(traceDirectory))
             {
                 Directory.CreateDirectory(traceDirectory);

Rubberduck.VBEEditor/ComManagement/ComSafeBase.cs

@@ -90,12 +90,7 @@ private struct TraceData
         private const int StackTrackNumberOfElementsToSkipOnAddUpdate = 8;
         private const int StackTraceDepth = 5;
 
-        /// <summary>
-        /// Provide a serialized list of the COM Safe
-        /// to make it easy to analyze what is inside
-        /// the COM Safe at the different points of
-        /// the session's lifetime.
-        /// </summary>
+        /// <inheritdoc cref="IComSafe.Serialize"/>
         public void Serialize(string targetDirectory)
         {
             lock (_streamLock)

Rubberduck.VBEEditor/ComManagement/IComSafe.cs

@@ -8,6 +8,12 @@ public interface IComSafe: IDisposable
         void Add(ISafeComWrapper comWrapper);
         bool TryRemove(ISafeComWrapper comWrapper);
 #if DEBUG
+        /// <summary>
+        /// Available in DEBUG build only. Provide a mechanism for serializing both
+        /// a snapshot of the COM safe at the instant and a historical activity log
+        /// with a limited stack trace for each entry.
+        /// </summary>
+        /// <param name="targetDirectory">The path to a directory to place the serialized files in</param>
         void Serialize(string targetDirectory);
 #endif
     }