Skip to content

Commit

Permalink
Merge pull request soygul#13 from Stef569/master
Browse files Browse the repository at this point in the history
Fixes the 'red->read' spelling in settings.cs, Show the tooltip in the configurator for a longer time
  • Loading branch information
soygul committed Jul 13, 2013
2 parents daad613 + 293653d commit 5bc1613
Show file tree
Hide file tree
Showing 4 changed files with 31 additions and 32 deletions.
2 changes: 1 addition & 1 deletion NBug.Configurator/MainForm.Designer.cs

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

10 changes: 5 additions & 5 deletions NBug.Configurator/MainForm.resx
Original file line number Diff line number Diff line change
Expand Up @@ -161,11 +161,11 @@ if you want to get best result automatically.</value>
generating bug reports for a corrupted process may not be successful, so use with caution.</value>
</data>
<data name="exitApplicationImmediatelyCheckBox.ToolTip" xml:space="preserve">
<value>Indicates whether to exit application after handling an unhandled exception or sending error report.
<value>Indicates whether the application will exit after handling and logging an unhandled exception.
This value is disregarded for anything but UIMode.None. For UIMode.None, you can choose not to exit
application which will result in 'Windows Error Reporting' (aka Dr. Watson) window to kick in.
This may also be helpful in using NBug library as a simple unhandled exception logger facility, just
to log and submit exceptions but does not interfere with the application execution flow.</value>
the application which will result in 'Windows Error Reporting' (aka Dr. Watson) window to kick in.
This may also be helpful in using the NBug library as a simple unhandled exception logger facility,
just to log and submit exceptions but not interfering with the application execution flow.</value>
</data>
<data name="warningLabel.Text" xml:space="preserve">
<value>Warning: Do not change the below default values before fully reading and comprehending the documentation (Help Menu &gt; Online Documentation) as the supplied defaults are good for most configurations. Hover your mouse over each item to get a quick tooltip explaining the item's functionality.</value>
Expand Down Expand Up @@ -253,4 +253,4 @@ to log and submit exceptions but does not interfere with the application executi
AADwDwAA8A8AAA==
</value>
</data>
</root>
</root>
50 changes: 25 additions & 25 deletions NBug/Settings.cs
Original file line number Diff line number Diff line change
Expand Up @@ -195,13 +195,13 @@ public static ICollection<IProtocol> Destinations
}

/// <summary>
/// Gets or sets the UI mode. You should only change this if you red the documentation and understood it. Otherwise leave it to auto.
/// Gets or sets the UI mode. You should only change this if you read the documentation and understood it. Otherwise leave it to auto.
/// Default value is Auto.
/// </summary>
public static UIMode UIMode { get; set; }

/// <summary>
/// Gets or sets the UI provider. You should only change this if you red the documentation and understood it. Otherwise leave it to auto.
/// Gets or sets the UI provider. You should only change this if you read the documentation and understood it. Otherwise leave it to auto.
/// Default value is Auto.
/// </summary>
public static UIProvider UIProvider { get; set; }
Expand All @@ -214,7 +214,7 @@ public static ICollection<IProtocol> Destinations
public static int SleepBeforeSend { get; set; }

/// <summary>
/// Gets or sets the number of bug reports that can be queued for submission. Each time an unhandled occurs, the bug report is prepared to
/// Gets or sets the number of bug reports that can be queued for submission. Each time an unhandled exception occurs, the bug report is prepared to
/// be send at the next application startup. If submission fails (i.e. there is no Internet connection), the queue grows with each additional
/// unhandled exception and resulting bug reports. This limits the max no of queued reports to limit the disk space usage.
/// Default value is 5.
Expand Down Expand Up @@ -255,35 +255,35 @@ public static ICollection<IProtocol> Destinations
public static bool WriteLogToDisk { get; set; }

/// <summary>
/// Gets or sets a value indicating whether to to exit application after handling an unhandled exception or sending error report. This value
/// is disregarded for anything but UIMode.None. For UIMode.None, you can choose not to exit application which will result in
/// Gets or sets a value indicating whether the application will exit after handling and logging an unhandled exception.
/// This value is disregarded for anything but UIMode.None. For UIMode.None, you can choose not to exit the application which will result in
/// 'Windows Error Reporting' (aka Dr. Watson) window to kick in. One reason to do so would be to keep in line with Windows 7 Logo requirements,
/// which is a corner case. This may also be helpful in using NBug library as a simple unhandled exception logger facility, just to log and submit
/// exceptions but does not interfere with the application execution flow. Default value is true.
/// which is a corner case. This may also be helpful in using the NBug library as a simple unhandled exception logger facility, just to log and submit
/// exceptions but not interfering with the application execution flow. Default value is true.
/// </summary>
public static bool ExitApplicationImmediately { get; set; }

/// <summary>
/// Gets or sets a value indicating whether to handled exceptions even in a corrupted process thought the 'HandleProcessCorruptedStateExceptions'
/// Gets or sets a value indicating whether to handle exceptions even in a corrupted process thought the 'HandleProcessCorruptedStateExceptions'
/// flag. The default value for this is false since generating bug reports for a corrupted process may not be successful so use with caution.
/// </summary>
public static bool HandleProcessCorruptedStateExceptions { get; set; }

/// <summary>
/// Gets or sets a value indicating whether to use deferred reporting feature. With this feature enabled, all bug reports are sent
/// Gets or sets a value indicating whether to use the deferred reporting feature. With this feature enabled, all bug reports are sent
/// after the next application start and as a background task. This helps facilitate sending of bug reports with large memory dumps
/// with them. When this feature is disabled, bug reports are sent as soon as an unhandled exception is caught. For the users, it is
/// very uncomfortable to wait for bug reports to be sent after an application crash, so it is best to leave this feature on.
/// Default value is true.
/// </summary>
private static bool DeferredReporting { get; set; } // ToDo: Complete the implementation for non-defered report sending
private static bool DeferredReporting { get; set; } // ToDo: Complete the implementation for non-deferred report sending

private static bool releaseMode; // False by default

/// <summary>
/// Gets or sets a value indicating whether to enable release mode for NBug library. In release mode, internal developer UI is not displayed and
/// Gets or sets a value indicating whether to enable release mode for the NBug library. In release mode the internal developer UI is not displayed and
/// unhandled exceptions are only handled if there is no debugger attached to the process. Once properly configured and verified to be working
/// as intended, NBug release mode should be enabled to be able properly to use Visual Studio debugger, without NBug trying to handle exceptions
/// as intended, NBug release mode should be enabled to be able to properly use the Visual Studio debugger, without NBug trying to handle exceptions.
/// before Visual Studio does. Default value is false.
/// </summary>
public static bool ReleaseMode
Expand Down Expand Up @@ -328,11 +328,11 @@ public static bool ReleaseMode

/// <summary>
/// Gets or sets a list of additional files to be added to the report zip. The files can use * or ? in the same way as DOS modifiers.
/// </summary>
/// </summary>
public static List<string> AdditionalReportFiles { get; set; }

/// <summary>
/// Gets or sets a evento for CustomUI.
/// Gets or sets an event for a CustomUI.
/// </summary>
internal static Delegate CustomUIHandle;
public static event EventHandler<CustomUIEventArgs> CustomUIEvent
Expand Down Expand Up @@ -398,7 +398,7 @@ public static event EventHandler<CustomUIEventArgs> CustomUIEvent
internal static bool HandleExceptions { get; set; }

/// <summary>
/// Gets or sets a value indicating whether the dispatcher, the class deals with sending of reports to their destinations like mail
/// Gets or sets a value indicating whether the dispatcher the class deals with sending of reports to their destinations like mail
/// address or an issue tracker, runs asynchronously (in a background worker thread as a <see cref="System.Threading.Tasks.Task"/>).
/// By default dispatcher runs on a background thread except for debug builds, where it blocks the UI and runs in a synchronous manner.
/// This is made so to prevent any exceptions thrown by the dispatcher from being swallowed by the CLR since background thread exceptions
Expand All @@ -412,10 +412,10 @@ public static event EventHandler<CustomUIEventArgs> CustomUIEvent
internal static bool SkipDispatching { get; set; }

/// <summary>
/// Gets or sets a value indicating whether to remove the all the <see cref="System.Threading.Thread.Sleep(int)"/> statements from
/// the thread executions. Some thread sleep statements are place around to increase the host application performance i.e. the
/// Gets or sets a value indicating whether to remove all the <see cref="System.Threading.Thread.Sleep(int)"/> statements from
/// the thread executions. Some thread sleep statements are used to increase the host application performance i.e. the
/// <see cref="Settings.SleepBeforeSend"/> halts the execution of <see cref="Dispatcher.Dispatch()"/> for a given number of
/// seconds to let host application initialize properly.
/// seconds to let the host application initialize properly.
/// </summary>
internal static bool RemoveThreadSleep { get; set; }

Expand All @@ -424,7 +424,7 @@ public static event EventHandler<CustomUIEventArgs> CustomUIEvent
#region Load Save Settings Methods

/// <summary>
/// This should not be used directly. Rather, <see cref="SettingsOverride.LoadCustomSettings(Stream)"/> should be prefered.
/// This should not be used directly. Rather, <see cref="SettingsOverride.LoadCustomSettings(Stream)"/> should be preferred.
/// </summary>
internal static void LoadCustomSettings(XElement config)
{
Expand Down Expand Up @@ -515,7 +515,7 @@ where element.Attribute("name") != null && element.Element("value") != null
}
else
{
Logger.Error("There is a problem with the 'applicationSettings' section of the configuration file. The property red from the file '" + property + "' is undefined. This is probably a refactoring problem, or malformed config file.");
Logger.Error("There is a problem with the 'applicationSettings' section of the configuration file. The property read from the file '" + property + "' is undefined. This is probably a refactoring problem, or a malformed config file.");
}
}

Expand Down Expand Up @@ -549,15 +549,15 @@ where element.Attribute("name") != null && element.Attribute("connectionString")
}
else
{
Logger.Error("There is a problem with the 'connectionStrings' section of the configuration file. The property red from the file '" + property + "' is undefined. This is probably a refactoring problem, or malformed config file.");
Logger.Error("There is a problem with the 'connectionStrings' section of the configuration file. The property read from the file '" + property + "' is undefined. This is probably a refactoring problem, or malformed config file.");
}
}

var x = _availableProtocols.Value;
}

/// <summary>
/// This should not be used directly. Rather, <see cref="SettingsOverride.SaveCustomSettings(Stream)"/> should be prefered.
/// This should not be used directly. Rather <see cref="SettingsOverride.SaveCustomSettings(Stream)"/> should be preferred.
/// </summary>
internal static void SaveCustomSettings(Stream settingsFile, bool encryptConnectionStrings)
{
Expand Down Expand Up @@ -715,7 +715,7 @@ where appSetting.Attribute("name") != null &&
settingsFile.Flush();
config.Save(settingsFile);
settingsFile.Flush();
}
}

#endregion

Expand Down Expand Up @@ -758,7 +758,7 @@ private static void LoadAppconfigSettings()
AddDestinationFromConnectionString(Decrypt(Properties.Settings.Default.Destination3));
AddDestinationFromConnectionString(Decrypt(Properties.Settings.Default.Destination4));
AddDestinationFromConnectionString(Decrypt(Properties.Settings.Default.Destination5));
}
}

private static string Decrypt(string connectionString)
{
Expand Down Expand Up @@ -867,7 +867,7 @@ private static T GetDefaultEnumValue<T>()
private static string GetPropertyName<T>(Expression<Func<T>> propertyExpression)
{
return ((MemberExpression)propertyExpression.Body).Member.Name;
}
}

#endregion
}
Expand Down
1 change: 0 additions & 1 deletion ToDo.txt
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@ Add F1 help to configurator via .chm documentation file
Update DbgHelp library to detect x64/x86 platform changes
Unit tests for: Can use Settings.StopReportingAfter <= 0 and Settings.MaxQueuedReports <= 0 for infinite reports
Refactor the code for NBug.Settings.AdditionalReportFiles.Add(Environment.CurrentDirectory + "\\Log.txt"); (the report generation part)
The property red from the file '***' is undefined. (it should be 'read' not 'red').
static void Main(string[] args)
{
AppDomain.CurrentDomain.UnhandledException += NBug.Handler.UnhandledException;
Expand Down

0 comments on commit 5bc1613

Please sign in to comment.