Skip to content

CoreCLR: Automatically port System.GC* triple slash comments to Docs #2759

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

Merged
merged 6 commits into from
Jul 17, 2019
Merged

CoreCLR: Automatically port System.GC* triple slash comments to Docs #2759

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
ef95cb1
CoreCLR: Automatically port System.GC* triple slash comments to Docs
carlossanlop Jul 15, 2019
021f703
Add return for GetTotalAllocatedBytes
carlossanlop Jul 15, 2019
b96d260
Fix some values
carlossanlop Jul 15, 2019
ea26c49
GCMemoryInfo summary
carlossanlop Jul 15, 2019
6c7702a
Update GC.xml
Jul 16, 2019
c155484
Update GCMemoryInfo.xml
Jul 16, 2019
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
6 changes: 3 additions & 3 deletions xml/System/GC.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -929,9 +929,9 @@ This method is most useful in monitoring scenarios for measuring the difference
<Parameter Name="precise" Type="System.Boolean" Index="0" FrameworkAlternate="netcore-3.0" />
</Parameters>
<Docs>
<param name="precise">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="precise">If <see langword="true" />, gather a precise number, otherwise gather a fairly count. Gathering a precise value triggers at a significant performance penalty.</param>
<summary>Get a count of the bytes allocated over the lifetime of the process.</summary>
<returns>The total bytes allocated over the lifetime of the process.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
48 changes: 39 additions & 9 deletions xml/System/GCMemoryInfo.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,9 +39,27 @@
<ReturnType>System.Int64</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>Gets the total fragmentation when the last garbage collection occurred.</summary>
<value>The total fragmentation when the last garbage collection occurred.</value>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks


Let's take the example below:
| OBJ_A | OBJ_B | OBJ_C | OBJ_D | OBJ_E |

Let's say OBJ_B, OBJ_C and and OBJ_E are garbage and get collected, but the heap does not get compacted. The resulting heap will look like the following:

| OBJ_A | F | OBJ_D |

The memory between OBJ_A and OBJ_D marked `F` is considered part of the `FragmentedBytes`, and will be used to allocate new objects.

The memory after OBJ_D will not be considered part of the `FragmentedBytes`, and will also be used to allocate new objects.

]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="HeapSizeBytes">
Expand All @@ -60,7 +78,7 @@
<ReturnType>System.Int64</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>The total heap size when the last garbage collection occurred.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand All @@ -81,7 +99,7 @@
<ReturnType>System.Int64</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>High memory load threshold when the last garbage collection occured.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand All @@ -102,7 +120,7 @@
<ReturnType>System.Int64</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Memory load when the last garbage collection occurred.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand All @@ -123,9 +141,21 @@
<ReturnType>System.Int64</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>Gets the total available memory for the garbage collector to use when the last garbage collection occurred.</summary>
<value>TThe total available memory for the garbage collector to use when the last garbage collection occurred.</value>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

If the environment variable `COMPlus_GCHeapHardLimit` is set, or `Server.GC.HeapHardLimit` is in `runtimeconfig.json`, this will come from that.

If the program is run in a container, this will be an implementation-defined fraction of the container's size.

Otherwise, this is the physical memory on the machine that was available for the garbage collector to use when the last garbage collection occurred.

]]></format>
</remarks>
</Docs>
</Member>
</Members>
Expand Down