Skip to content

Commit

Permalink
minor updates to readme and xml comments for release
Browse files Browse the repository at this point in the history
  • Loading branch information
PandaWood committed Aug 11, 2018
1 parent fbd17e4 commit 6733605
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 15 deletions.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@ In the next screenshot, we have an example of some customization that can be mad
There are no images on the buttons,
the window title is customised and an extra Tab (_Contact_) is visible

You can also hide the email button and various other options - see the property `Config` on the main `ExceptionReporter` class.

![Customized Example](images/er-customized.png)

The buttons for *More detail* and *Less Detail* allow the user to switch between these modes.
Expand All @@ -32,7 +34,7 @@ The Exception Reporter can be called manually or by setting up a Windows Excepti
see [Sample Code Usage](https://github.com/PandaWood/Exception-Reporter/wiki/Sample-Usage)

The report can be sent silently or the dialog (above) shown, which is then populated with the exception and certain system details.
A screenshot can be taken and you can easily add file attachments (if using email as the method of sending).
A screenshot can be taken and file attachments added (if using email as the method of sending).

The ultimate goal is the developer receiving a formatted exception report - see
[Creating and Sending a Report](https://github.com/PandaWood/Exception-Reporter/wiki/Creating-and-Sending-a-Report)
Expand Down
7 changes: 3 additions & 4 deletions src/ExceptionReporter/ExceptionReporter.cs
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
using System;
using System.Reflection;
using System.Windows.Forms;
using ExceptionReporting.MVP;
using ExceptionReporting.MVP.Views;
using ExceptionReporting.Network;
using ExceptionReporting.Network.Events;
Expand Down Expand Up @@ -80,10 +79,10 @@ public void Show(string customMessage, params Exception[] exceptions)
}

/// <summary>
/// Send the report without showing a dialog (silent send)
/// Send the report, asynchronously, without showing a dialog (silent send)
/// <see cref="ExceptionReportInfo.SendMethod"/>must be SMTP or WebService, else this is ignored (silently)
/// </summary>
/// <param name="sendEvent">Provide implementation of IReportSendEvent to receive error/updates</param>
/// <param name="sendEvent">Provide implementation of IReportSendEvent to receive error/updates on calling thread</param>
/// <param name="exceptions">The exception/s to include in the report</param>
public void Send(IReportSendEvent sendEvent = null, params Exception[] exceptions)
{
Expand All @@ -95,7 +94,7 @@ public void Send(IReportSendEvent sendEvent = null, params Exception[] exception
}

/// <summary>
/// Send the report without showing a dialog (silent send)
/// Send the report, asynchronously, without showing a dialog (silent send)
/// <see cref="ExceptionReportInfo.SendMethod"/>must be SMTP or WebService, else this is ignored (silently)
/// </summary>
/// <param name="exceptions">The exception/s to include in the report</param>
Expand Down
13 changes: 3 additions & 10 deletions src/Test.ExceptionReporter/Attacher_Tests.cs
Original file line number Diff line number Diff line change
Expand Up @@ -125,9 +125,7 @@ public void Should_Take_Screenshot_If_Configured()
var screenshot = new Mock<IScreenshotTaker>();
var attacher =
new Attacher(new ExceptionReportInfo {TakeScreenshot = true})
{
ScreenshotTaker = screenshot.Object
};
{ ScreenshotTaker = screenshot.Object };

attacher.AttachFiles(_iattach.Object);

Expand All @@ -140,9 +138,7 @@ public void Should_Not_Take_Screenshot_If_Not_Configured()
var screenshot = new Mock<IScreenshotTaker>();
var attacher =
new Attacher(new ExceptionReportInfo { TakeScreenshot = false })
{
ScreenshotTaker = screenshot.Object
};
{ ScreenshotTaker = screenshot.Object };

attacher.AttachFiles(_iattach.Object);

Expand All @@ -164,10 +160,7 @@ public void Should_Not_Take_Screenshot_If_Already_Taken()
{
TakeScreenshot = true,
ScreenshotImage = bm // this makes the screenshot "already taken" ie exists
})
{
ScreenshotTaker = screenshot.Object,
};
}) { ScreenshotTaker = screenshot.Object };

attacher.AttachFiles(_iattach.Object);
}
Expand Down

0 comments on commit 6733605

Please sign in to comment.