Skip to content

Intellisense - Generate public API documentation #35

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Intellisense - Generate public API documentation #35

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2de64ee
Let the XML document generate so the Nuget packages provide the docum…
Sep 5, 2023
a12de37
Improve API documentation part 1.
Sep 5, 2023
aa0c05a
Improve API documentation part 2: punctuation.
Sep 5, 2023
bb4dc79
Improve API documentation part 3: the forgotten saves.
Sep 5, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions SmartThreadPool/Exceptions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ namespace Amib.Threading
#region Exceptions

/// <summary>
/// Represents an exception in case IWorkItemResult.GetResult has been canceled
/// Represents an exception in case IWorkItemResult.GetResult has been canceled.
/// </summary>
public sealed partial class WorkItemCancelException : Exception
{
Expand All @@ -26,7 +26,7 @@ public WorkItemCancelException(string message, Exception e)
}

/// <summary>
/// Represents an exception in case IWorkItemResult.GetResult has been timed out
/// Represents an exception in case IWorkItemResult.GetResult has been timed out.
/// </summary>
public sealed partial class WorkItemTimeoutException : Exception
{
Expand All @@ -46,7 +46,7 @@ public WorkItemTimeoutException(string message, Exception e)
}

/// <summary>
/// Represents an exception in case IWorkItemResult.GetResult has been timed out
/// Represents an exception in case IWorkItemResult.GetResult has been timed out.
/// </summary>
public sealed partial class WorkItemResultException : Exception
{
Expand All @@ -68,7 +68,7 @@ public WorkItemResultException(string message, Exception e)

/// <summary>
/// Represents an exception in case the STP queue is full and work item cannot be queued.
/// Relevant when the STP has a queue size limit
/// Relevant when the STP has a queue size limit.
/// </summary>
public sealed partial class QueueRejectedException : Exception
{
Expand All @@ -88,7 +88,7 @@ public QueueRejectedException(string message, Exception e)
}

/// <summary>
/// Represents an exception in case IWorkItemResult.GetResult has been canceled
/// Represents an exception in case IWorkItemResult.GetResult has been canceled.
/// </summary>
[Serializable]
public sealed partial class WorkItemCancelException
Expand All @@ -100,7 +100,7 @@ public WorkItemCancelException(SerializationInfo si, StreamingContext sc)
}

/// <summary>
/// Represents an exception in case IWorkItemResult.GetResult has been timed out
/// Represents an exception in case IWorkItemResult.GetResult has been timed out.
/// </summary>
[Serializable]
public sealed partial class WorkItemTimeoutException
Expand All @@ -112,7 +112,7 @@ public WorkItemTimeoutException(SerializationInfo si, StreamingContext sc)
}

/// <summary>
/// Represents an exception in case IWorkItemResult.GetResult has been timed out
/// Represents an exception in case IWorkItemResult.GetResult has been timed out.
/// </summary>
[Serializable]
public sealed partial class WorkItemResultException
Expand All @@ -124,7 +124,7 @@ public WorkItemResultException(SerializationInfo si, StreamingContext sc)
}

/// <summary>
/// Represents an exception in case IWorkItemResult.GetResult has been timed out
/// Represents an exception in case IWorkItemResult.GetResult has been timed out.
/// </summary>
[Serializable]
public sealed partial class QueueRejectedException
Expand Down
Loading