Update version numbers, regenerate documentation (#269)

Co-authored-by: Ben Watson <[email protected]>
microsoft · Feb 7, 2023 · 27f27f4 · 27f27f4
1 parent ef7f82f
commit 27f27f4
Show file tree

Hide file tree

Showing 19 changed files with 81 additions and 31 deletions.
diff --git a/docs/Microsoft.IO/RecyclableMemoryStreamManager.BlockCreatedEventArgs.md b/docs/Microsoft.IO/RecyclableMemoryStreamManager.BlockCreatedEventArgs.md
@@ -1,6 +1,6 @@
 # RecyclableMemoryStreamManager.BlockCreatedEventArgs class
 
-Arguments for the BlockCreated event.
+Arguments for the [`BlockCreated`](./RecyclableMemoryStreamManager/BlockCreated.md) event.
 
 ```csharp
 public sealed class BlockCreatedEventArgs : EventArgs

diff --git a/docs/Microsoft.IO/RecyclableMemoryStreamManager.BufferDiscardedEventArgs.md b/docs/Microsoft.IO/RecyclableMemoryStreamManager.BufferDiscardedEventArgs.md
@@ -1,6 +1,6 @@
 # RecyclableMemoryStreamManager.BufferDiscardedEventArgs class
 
-Arguments for the BufferDiscarded event.
+Arguments for the [`BufferDiscarded`](./RecyclableMemoryStreamManager/BufferDiscarded.md) event.
 
 ```csharp
 public sealed class BufferDiscardedEventArgs : EventArgs

diff --git a/.../Microsoft.IO/RecyclableMemoryStreamManager.Events/MemoryStreamDiscardBuffer.md b/.../Microsoft.IO/RecyclableMemoryStreamManager.Events/MemoryStreamDiscardBuffer.md
@@ -4,7 +4,9 @@ Logged when a buffer is discarded (not put back in the pool, but given to GC to
 
 ```csharp
 public void MemoryStreamDiscardBuffer(Guid guid, string tag, MemoryStreamBufferType bufferType, 
-    MemoryStreamDiscardReason reason)
+    MemoryStreamDiscardReason reason, long smallBlocksFree, long smallPoolBytesFree, 
+    long smallPoolBytesInUse, long largeBlocksFree, long largePoolBytesFree, 
+    long largePoolBytesInUse)
 ```
 
 | parameter | description |
@@ -13,6 +15,12 @@ public void MemoryStreamDiscardBuffer(Guid guid, string tag, MemoryStreamBufferT
 | tag | A temporary ID for this stream, usually indicates current usage. |
 | bufferType | Type of the buffer being discarded. |
 | reason | Reason for the discard. |
+| smallBlocksFree | Number of free small pool blocks. |
+| smallPoolBytesFree | Bytes free in the small pool. |
+| smallPoolBytesInUse | Bytes in use from the small pool. |
+| largeBlocksFree | Number of free large pool blocks. |
+| largePoolBytesFree | Bytes free in the large pool. |
+| largePoolBytesInUse | Bytes in use from the large pool. |
 
 ## See Also
 

diff --git a/docs/Microsoft.IO/RecyclableMemoryStreamManager.Events/MemoryStreamDisposed.md b/docs/Microsoft.IO/RecyclableMemoryStreamManager.Events/MemoryStreamDisposed.md
@@ -3,13 +3,15 @@
 Logged when the stream is disposed.
 
 ```csharp
-public void MemoryStreamDisposed(Guid guid, string tag, string allocationStack, string disposeStack)
+public void MemoryStreamDisposed(Guid guid, string tag, TimeSpan lifetime, string allocationStack, 
+    string disposeStack)
 ```
 
 | parameter | description |
 | --- | --- |
 | guid | A unique ID for this stream. |
 | tag | A temporary ID for this stream, usually indicates current usage. |
+| lifetime | Lifetime of the stream |
 | allocationStack | Call stack of initial allocation. |
 | disposeStack | Call stack of the dispose. |
 

diff --git a/docs/Microsoft.IO/RecyclableMemoryStreamManager.LargeBufferCreatedEventArgs.md b/docs/Microsoft.IO/RecyclableMemoryStreamManager.LargeBufferCreatedEventArgs.md
@@ -1,6 +1,6 @@
 # RecyclableMemoryStreamManager.LargeBufferCreatedEventArgs class
 
-Arguments for the LargeBufferCreated events.
+Arguments for the [`LargeBufferCreated`](./RecyclableMemoryStreamManager/LargeBufferCreated.md) events.
 
 ```csharp
 public sealed class LargeBufferCreatedEventArgs : EventArgs
@@ -10,7 +10,7 @@ public sealed class LargeBufferCreatedEventArgs : EventArgs
 
 | name | description |
 | --- | --- |
-| [CallStack](RecyclableMemoryStreamManager.LargeBufferCreatedEventArgs/CallStack.md) { get; } | If the buffer was not satisfied from the pool, and GenerateCallstacks is turned on, then. this will contain the callstack of the allocation request. |
+| [CallStack](RecyclableMemoryStreamManager.LargeBufferCreatedEventArgs/CallStack.md) { get; } | If the buffer was not satisfied from the pool, and [`GenerateCallStacks`](./RecyclableMemoryStreamManager/GenerateCallStacks.md) is turned on, then. this will contain the callstack of the allocation request. |
 | [Id](RecyclableMemoryStreamManager.LargeBufferCreatedEventArgs/Id.md) { get; } | Unique ID for the stream. |
 | [LargePoolInUse](RecyclableMemoryStreamManager.LargeBufferCreatedEventArgs/LargePoolInUse.md) { get; } | How many bytes are in use from the large pool. |
 | [Pooled](RecyclableMemoryStreamManager.LargeBufferCreatedEventArgs/Pooled.md) { get; } | Whether the buffer was satisfied from the pool or not. |

diff --git a/...osoft.IO/RecyclableMemoryStreamManager.LargeBufferCreatedEventArgs/CallStack.md b/...osoft.IO/RecyclableMemoryStreamManager.LargeBufferCreatedEventArgs/CallStack.md
@@ -1,6 +1,6 @@
 # RecyclableMemoryStreamManager.LargeBufferCreatedEventArgs.CallStack property
 
-If the buffer was not satisfied from the pool, and GenerateCallstacks is turned on, then. this will contain the callstack of the allocation request.
+If the buffer was not satisfied from the pool, and [`GenerateCallStacks`](../RecyclableMemoryStreamManager/GenerateCallStacks.md) is turned on, then. this will contain the callstack of the allocation request.
 
 ```csharp
 public string CallStack { get; }

diff --git a/docs/Microsoft.IO/RecyclableMemoryStreamManager.StreamConvertedToArrayEventArgs.md b/docs/Microsoft.IO/RecyclableMemoryStreamManager.StreamConvertedToArrayEventArgs.md
@@ -1,6 +1,6 @@
 # RecyclableMemoryStreamManager.StreamConvertedToArrayEventArgs class
 
-Arguments for the StreamConvertedToArray event.
+Arguments for the [`StreamConvertedToArray`](./RecyclableMemoryStreamManager/StreamConvertedToArray.md) event.
 
 ```csharp
 public sealed class StreamConvertedToArrayEventArgs : EventArgs

diff --git a/docs/Microsoft.IO/RecyclableMemoryStreamManager.StreamCreatedEventArgs.md b/docs/Microsoft.IO/RecyclableMemoryStreamManager.StreamCreatedEventArgs.md
@@ -1,6 +1,6 @@
 # RecyclableMemoryStreamManager.StreamCreatedEventArgs class
 
-Arguments for the StreamCreated event.
+Arguments for the [`StreamCreated`](./RecyclableMemoryStreamManager/StreamCreated.md) event.
 
 ```csharp
 public sealed class StreamCreatedEventArgs : EventArgs

diff --git a/docs/Microsoft.IO/RecyclableMemoryStreamManager.StreamDisposedEventArgs.md b/docs/Microsoft.IO/RecyclableMemoryStreamManager.StreamDisposedEventArgs.md
@@ -1,6 +1,6 @@
 # RecyclableMemoryStreamManager.StreamDisposedEventArgs class
 
-Arguments for the StreamDisposed event.
+Arguments for the [`StreamDisposed`](./RecyclableMemoryStreamManager/StreamDisposed.md) event.
 
 ```csharp
 public sealed class StreamDisposedEventArgs : EventArgs
@@ -10,10 +10,11 @@ public sealed class StreamDisposedEventArgs : EventArgs
 
 | name | description |
 | --- | --- |
-| [StreamDisposedEventArgs](RecyclableMemoryStreamManager.StreamDisposedEventArgs/StreamDisposedEventArgs.md)(…) | Initializes a new instance of the [`StreamDisposedEventArgs`](./RecyclableMemoryStreamManager.StreamDisposedEventArgs.md) class. |
+| [StreamDisposedEventArgs](RecyclableMemoryStreamManager.StreamDisposedEventArgs/StreamDisposedEventArgs.md)(…) | Initializes a new instance of the [`StreamDisposedEventArgs`](./RecyclableMemoryStreamManager.StreamDisposedEventArgs.md) class. (2 constructors) |
 | [AllocationStack](RecyclableMemoryStreamManager.StreamDisposedEventArgs/AllocationStack.md) { get; } | Stack where the stream was allocated. |
 | [DisposeStack](RecyclableMemoryStreamManager.StreamDisposedEventArgs/DisposeStack.md) { get; } | Stack where stream was disposed. |
 | [Id](RecyclableMemoryStreamManager.StreamDisposedEventArgs/Id.md) { get; } | Unique ID for the stream. |
+| [Lifetime](RecyclableMemoryStreamManager.StreamDisposedEventArgs/Lifetime.md) { get; } | Lifetime of the stream. |
 | [Tag](RecyclableMemoryStreamManager.StreamDisposedEventArgs/Tag.md) { get; } | Optional Tag for the event. |
 
 ## See Also

diff --git a/.../Microsoft.IO/RecyclableMemoryStreamManager.StreamDisposedEventArgs/Lifetime.md b/.../Microsoft.IO/RecyclableMemoryStreamManager.StreamDisposedEventArgs/Lifetime.md
@@ -0,0 +1,14 @@
+# RecyclableMemoryStreamManager.StreamDisposedEventArgs.Lifetime property
+
+Lifetime of the stream.
+
+```csharp
+public TimeSpan Lifetime { get; }
+```
+
+## See Also
+
+* class [StreamDisposedEventArgs](../RecyclableMemoryStreamManager.StreamDisposedEventArgs.md)
+* namespace [Microsoft.IO](../../Microsoft.IO.RecyclableMemoryStream.md)
+
+<!-- DO NOT EDIT: generated by xmldocmd for Microsoft.IO.RecyclableMemoryStream.dll -->
diff --git a/...ecyclableMemoryStreamManager.StreamDisposedEventArgs/StreamDisposedEventArgs.md b/...ecyclableMemoryStreamManager.StreamDisposedEventArgs/StreamDisposedEventArgs.md
@@ -1,8 +1,9 @@
-# RecyclableMemoryStreamManager.StreamDisposedEventArgs constructor
+# RecyclableMemoryStreamManager.StreamDisposedEventArgs constructor (1 of 2)
 
 Initializes a new instance of the [`StreamDisposedEventArgs`](../RecyclableMemoryStreamManager.StreamDisposedEventArgs.md) class.
 
 ```csharp
+[Obsolete("Use another constructor override")]
 public StreamDisposedEventArgs(Guid guid, string tag, string allocationStack, string disposeStack)
 ```
 
@@ -18,4 +19,28 @@ public StreamDisposedEventArgs(Guid guid, string tag, string allocationStack, st
 * class [StreamDisposedEventArgs](../RecyclableMemoryStreamManager.StreamDisposedEventArgs.md)
 * namespace [Microsoft.IO](../../Microsoft.IO.RecyclableMemoryStream.md)
 
+---
+
+# RecyclableMemoryStreamManager.StreamDisposedEventArgs constructor (2 of 2)
+
+Initializes a new instance of the [`StreamDisposedEventArgs`](../RecyclableMemoryStreamManager.StreamDisposedEventArgs.md) class.
+
+```csharp
+public StreamDisposedEventArgs(Guid guid, string tag, TimeSpan lifetime, string allocationStack, 
+    string disposeStack)
+```
+
+| parameter | description |
+| --- | --- |
+| guid | Unique ID of the stream. |
+| tag | Tag of the stream. |
+| lifetime | Lifetime of the stream |
+| allocationStack | Stack of original allocation. |
+| disposeStack | Dispose stack. |
+
+## See Also
+
+* class [StreamDisposedEventArgs](../RecyclableMemoryStreamManager.StreamDisposedEventArgs.md)
+* namespace [Microsoft.IO](../../Microsoft.IO.RecyclableMemoryStream.md)
+
 <!-- DO NOT EDIT: generated by xmldocmd for Microsoft.IO.RecyclableMemoryStream.dll -->
diff --git a/docs/Microsoft.IO/RecyclableMemoryStreamManager.StreamDoubleDisposedEventArgs.md b/docs/Microsoft.IO/RecyclableMemoryStreamManager.StreamDoubleDisposedEventArgs.md
@@ -1,6 +1,6 @@
 # RecyclableMemoryStreamManager.StreamDoubleDisposedEventArgs class
 
-Arguments for the StreamDoubleDisposed event.
+Arguments for the [`StreamDoubleDisposed`](./RecyclableMemoryStreamManager/StreamDoubleDisposed.md) event.
 
 ```csharp
 public sealed class StreamDoubleDisposedEventArgs : EventArgs

diff --git a/docs/Microsoft.IO/RecyclableMemoryStreamManager.StreamFinalizedEventArgs.md b/docs/Microsoft.IO/RecyclableMemoryStreamManager.StreamFinalizedEventArgs.md
@@ -1,6 +1,6 @@
 # RecyclableMemoryStreamManager.StreamFinalizedEventArgs class
 
-Arguments for the StreamFinalized event.
+Arguments for the [`StreamFinalized`](./RecyclableMemoryStreamManager/StreamFinalized.md) event.
 
 ```csharp
 public sealed class StreamFinalizedEventArgs : EventArgs

diff --git a/docs/Microsoft.IO/RecyclableMemoryStreamManager.StreamLengthEventArgs.md b/docs/Microsoft.IO/RecyclableMemoryStreamManager.StreamLengthEventArgs.md
@@ -1,6 +1,6 @@
 # RecyclableMemoryStreamManager.StreamLengthEventArgs class
 
-Arguments for the StreamLength event.
+Arguments for the [`StreamLength`](./RecyclableMemoryStreamManager/StreamLength.md) event.
 
 ```csharp
 public sealed class StreamLengthEventArgs : EventArgs

diff --git a/docs/Microsoft.IO/RecyclableMemoryStreamManager.StreamOverCapacityEventArgs.md b/docs/Microsoft.IO/RecyclableMemoryStreamManager.StreamOverCapacityEventArgs.md
@@ -1,6 +1,6 @@
 # RecyclableMemoryStreamManager.StreamOverCapacityEventArgs class
 
-Arguments for the StreamOverCapacity event.
+Arguments for the [`StreamOverCapacity`](./RecyclableMemoryStreamManager/StreamOverCapacity.md) event.
 
 ```csharp
 public sealed class StreamOverCapacityEventArgs : EventArgs

diff --git a/docs/Microsoft.IO/RecyclableMemoryStreamManager.UsageReportEventArgs.md b/docs/Microsoft.IO/RecyclableMemoryStreamManager.UsageReportEventArgs.md
@@ -1,6 +1,6 @@
 # RecyclableMemoryStreamManager.UsageReportEventArgs class
 
-Arguments for the UsageReport event.
+Arguments for the [`UsageReport`](./RecyclableMemoryStreamManager/UsageReport.md) event.
 
 ```csharp
 public sealed class UsageReportEventArgs : EventArgs

diff --git a/docs/Microsoft.IO/RecyclableMemoryStreamManager.md b/docs/Microsoft.IO/RecyclableMemoryStreamManager.md
@@ -45,18 +45,18 @@ public sealed class RecyclableMemoryStreamManager
 | const [DefaultBlockSize](RecyclableMemoryStreamManager/DefaultBlockSize.md) | Default block size, in bytes. |
 | const [DefaultLargeBufferMultiple](RecyclableMemoryStreamManager/DefaultLargeBufferMultiple.md) | Default large buffer multiple, in bytes. |
 | const [DefaultMaximumBufferSize](RecyclableMemoryStreamManager/DefaultMaximumBufferSize.md) | Default maximum buffer size, in bytes. |
-| class [BlockCreatedEventArgs](RecyclableMemoryStreamManager.BlockCreatedEventArgs.md) | Arguments for the BlockCreated event. |
-| class [BufferDiscardedEventArgs](RecyclableMemoryStreamManager.BufferDiscardedEventArgs.md) | Arguments for the BufferDiscarded event. |
+| class [BlockCreatedEventArgs](RecyclableMemoryStreamManager.BlockCreatedEventArgs.md) | Arguments for the [`BlockCreated`](./RecyclableMemoryStreamManager/BlockCreated.md) event. |
+| class [BufferDiscardedEventArgs](RecyclableMemoryStreamManager.BufferDiscardedEventArgs.md) | Arguments for the [`BufferDiscarded`](./RecyclableMemoryStreamManager/BufferDiscarded.md) event. |
 | class [Events](RecyclableMemoryStreamManager.Events.md) | ETW events for RecyclableMemoryStream. |
-| class [LargeBufferCreatedEventArgs](RecyclableMemoryStreamManager.LargeBufferCreatedEventArgs.md) | Arguments for the LargeBufferCreated events. |
-| class [StreamConvertedToArrayEventArgs](RecyclableMemoryStreamManager.StreamConvertedToArrayEventArgs.md) | Arguments for the StreamConvertedToArray event. |
-| class [StreamCreatedEventArgs](RecyclableMemoryStreamManager.StreamCreatedEventArgs.md) | Arguments for the StreamCreated event. |
-| class [StreamDisposedEventArgs](RecyclableMemoryStreamManager.StreamDisposedEventArgs.md) | Arguments for the StreamDisposed event. |
-| class [StreamDoubleDisposedEventArgs](RecyclableMemoryStreamManager.StreamDoubleDisposedEventArgs.md) | Arguments for the StreamDoubleDisposed event. |
-| class [StreamFinalizedEventArgs](RecyclableMemoryStreamManager.StreamFinalizedEventArgs.md) | Arguments for the StreamFinalized event. |
-| class [StreamLengthEventArgs](RecyclableMemoryStreamManager.StreamLengthEventArgs.md) | Arguments for the StreamLength event. |
-| class [StreamOverCapacityEventArgs](RecyclableMemoryStreamManager.StreamOverCapacityEventArgs.md) | Arguments for the StreamOverCapacity event. |
-| class [UsageReportEventArgs](RecyclableMemoryStreamManager.UsageReportEventArgs.md) | Arguments for the UsageReport event. |
+| class [LargeBufferCreatedEventArgs](RecyclableMemoryStreamManager.LargeBufferCreatedEventArgs.md) | Arguments for the [`LargeBufferCreated`](./RecyclableMemoryStreamManager/LargeBufferCreated.md) events. |
+| class [StreamConvertedToArrayEventArgs](RecyclableMemoryStreamManager.StreamConvertedToArrayEventArgs.md) | Arguments for the [`StreamConvertedToArray`](./RecyclableMemoryStreamManager/StreamConvertedToArray.md) event. |
+| class [StreamCreatedEventArgs](RecyclableMemoryStreamManager.StreamCreatedEventArgs.md) | Arguments for the [`StreamCreated`](./RecyclableMemoryStreamManager/StreamCreated.md) event. |
+| class [StreamDisposedEventArgs](RecyclableMemoryStreamManager.StreamDisposedEventArgs.md) | Arguments for the [`StreamDisposed`](./RecyclableMemoryStreamManager/StreamDisposed.md) event. |
+| class [StreamDoubleDisposedEventArgs](RecyclableMemoryStreamManager.StreamDoubleDisposedEventArgs.md) | Arguments for the [`StreamDoubleDisposed`](./RecyclableMemoryStreamManager/StreamDoubleDisposed.md) event. |
+| class [StreamFinalizedEventArgs](RecyclableMemoryStreamManager.StreamFinalizedEventArgs.md) | Arguments for the [`StreamFinalized`](./RecyclableMemoryStreamManager/StreamFinalized.md) event. |
+| class [StreamLengthEventArgs](RecyclableMemoryStreamManager.StreamLengthEventArgs.md) | Arguments for the [`StreamLength`](./RecyclableMemoryStreamManager/StreamLength.md) event. |
+| class [StreamOverCapacityEventArgs](RecyclableMemoryStreamManager.StreamOverCapacityEventArgs.md) | Arguments for the [`StreamOverCapacity`](./RecyclableMemoryStreamManager/StreamOverCapacity.md) event. |
+| class [UsageReportEventArgs](RecyclableMemoryStreamManager.UsageReportEventArgs.md) | Arguments for the [`UsageReport`](./RecyclableMemoryStreamManager/UsageReport.md) event. |
 
 ## Remarks
 

diff --git a/src/Microsoft.IO.RecyclableMemoryStream.csproj b/src/Microsoft.IO.RecyclableMemoryStream.csproj
@@ -7,7 +7,7 @@
     <DocumentationFile>bin\$(Configuration)\$(TargetFramework)\Microsoft.IO.RecyclableMemoryStream.xml</DocumentationFile>
     <!-- NuGet properties -->
     <PackageId>Microsoft.IO.RecyclableMemoryStream</PackageId>
-    <PackageVersion>2.2.1</PackageVersion>
+    <PackageVersion>2.3.0</PackageVersion>
     <Title>Microsoft.IO.RecyclableMemoryStream</Title>
     <Authors>Microsoft</Authors>
     <Description>A pooled MemoryStream allocator to decrease GC load and improve performance on highly scalable systems.</Description>

diff --git a/src/Properties/AssemblyInfo.cs b/src/Properties/AssemblyInfo.cs
@@ -34,8 +34,8 @@
 // You can specify all the values or you can default the Build and Revision Numbers
 // by using the '*' as shown below:
 // [assembly: AssemblyVersion("1.0.*")]
-[assembly: AssemblyVersion("2.2.1.0")]
-[assembly: AssemblyFileVersion("2.2.1.0")]
+[assembly: AssemblyVersion("2.3.0.0")]
+[assembly: AssemblyFileVersion("2.3.0.0")]
 
 [assembly: CLSCompliant(true)]