Skip to content

Commit

Permalink
doc (IFileUploader.cs): add trivial comments explaining why IFileUplo…
Browse files Browse the repository at this point in the history
…aderEventEmittable is not part of the public interface IFileUploader
  • Loading branch information
ksidirop-laerdal committed Sep 30, 2024
1 parent 87cc117 commit 15990eb
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 2 deletions.
5 changes: 3 additions & 2 deletions Laerdal.McuMgr/Shared/FileUploader/Contracts/IFileUploader.cs
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,12 @@ namespace Laerdal.McuMgr.FileUploader.Contracts
/// <summary>Uploads a file on a specific Nordic-chip-based BLE device</summary>
/// <remarks>For the file-uploading process to even commence you need to be authenticated with the AED device that's being targeted.</remarks>
public interface IFileUploader :
IFileUploaderCommandable,
IFileUploaderQueryable,
IFileUploaderEventSubscribable,
IFileUploaderCommandable,
IFileUploaderCleanupable,
IFileUploaderEventSubscribable,
IDisposable
//IFileUploaderEventEmittable dont this interface is meant to be internal only
{
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@

namespace Laerdal.McuMgr.FileUploader.Contracts
{
//must be internal because there is absolutely no point for anyone outside this assembly to be able to raise these events
internal interface IFileUploaderEventEmittable
{
void OnCancelled(CancelledEventArgs ea);
Expand Down

0 comments on commit 15990eb

Please sign in to comment.