Skip to content

Extensions: DI, Configuration, Caching.Memory docs #4107

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

Jump to bottom
Merged
merged 3 commits into from
Sep 2, 2020
Merged

Extensions: DI, Configuration, Caching.Memory docs #4107

merged 3 commits into from
Sep 2, 2020

Conversation

maryamariyan
Copy link
Contributor

Summary

More docs on:

  • Microsoft.Extensions.Caching.Memory
  • Microsoft.Extensions.Configuration
  • Microsoft.Extensions.DependencyInjection

@maryamariyan
More docs on:
94d72a9 
- Microsoft.Extensions.Caching.Memory
- Microsoft.Extensions.Configuration
- Microsoft.Extensions.DependencyInjection
@maryamariyan maryamariyan requested a review from a team as a code owner April 14, 2020 00:23
@dotnet-bot dotnet-bot added this to the April 2020 milestone Apr 14, 2020
gewarren
gewarren reviewed Apr 24, 2020
View reviewed changes
xml/Microsoft.Extensions.Caching.Memory/MemoryCacheOptions.xml
@@ -185,7 +185,7 @@
<ReturnType>Microsoft.Extensions.Caching.Memory.MemoryCacheOptions</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets the default configured <typeparamref name="TOptions" /> instance.</summary>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure whether TOptions is meaningful here? Here's the preview: https://review.docs.microsoft.com/en-us/dotnet/api/microsoft.extensions.caching.memory.memorydistributedcacheoptions?branch=pr-en-us-4107&view=dotnet-plat-ext-3.1#explicit-interface-implementations

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, the description for CompactOnMemoryPressure on line 131 doesn't seem correct.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, the description for CompactOnMemoryPressure on line 131 doesn't seem correct.

@gewarren which part do you think is off for CompactOnMemoryPressure?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@maryamariyan It duplicates the description for ExpirationScanFrequency and doesn't seem to match the property name.

image

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems like CompactOnMemoryPressure is already obsolete

carlossanlop
carlossanlop reviewed Apr 24, 2020
View reviewed changes
carlossanlop
carlossanlop suggested changes Apr 24, 2020
View reviewed changes
Copy link
Contributor

@carlossanlop carlossanlop left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the PR, @maryamariyan . I left one suggestion to apply.
If you can, please fill out the elements that aren't yet documented.
Also, I don't see any exceptions ported. Can you re-run the tool with -skipExceptions false, to see if anything gets ported?

@BillWagner BillWagner modified the milestones: April 2020, June 2020 Jun 1, 2020
@maryamariyan maryamariyan mentioned this pull request Jun 12, 2020
Closed
11 tasks
@maryamariyan
Merge branch 'master' of https://github.com/dotnet/dotnet-api-docs in…
ed12eba 
…to more-mse-runtime

 Conflicts:
	xml/Microsoft.Extensions.DependencyInjection.Specification.Fakes/FakeService.xml
	xml/Microsoft.Extensions.DependencyInjection/ServiceProvider.xml
@opbld33
Copy link

opbld33 commented Sep 2, 2020

Docs Build status updates of commit ed12eba:

⚠️ Validation status: warnings

File Status Preview URL Details
xml/Microsoft.Extensions.Caching.Memory/MemoryCache.xml ⚠️Warning View Details
xml/Microsoft.Extensions.Caching.Memory/MemoryCacheOptions.xml ⚠️Warning View Details
xml/Microsoft.Extensions.Configuration/ChainedConfigurationProvider.xml ⚠️Warning View Details
xml/Microsoft.Extensions.Configuration/ConfigurationRoot.xml ⚠️Warning View Details
xml/Microsoft.Extensions.Configuration/FileConfigurationProvider.xml ⚠️Warning View Details
xml/Microsoft.Extensions.DependencyInjection/DefaultServiceProviderFactory.xml ⚠️Warning View Details
xml/Microsoft.Extensions.DependencyInjection/ServiceCollection.xml ⚠️Warning View Details
xml/Microsoft.Extensions.DependencyInjection/ServiceProvider.xml ⚠️Warning View Details

xml/Microsoft.Extensions.Caching.Memory/MemoryCache.xml

  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.Equals(System.Object)'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.GetHashCode'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.GetType'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.MemberwiseClone'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.ToString'.

xml/Microsoft.Extensions.Caching.Memory/MemoryCacheOptions.xml

  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.ObsoleteAttribute'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.Equals(System.Object)'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.GetHashCode'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.GetType'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.MemberwiseClone'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.ToString'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Microsoft.Extensions.Internal.ISystemClock'.

xml/Microsoft.Extensions.Configuration/ChainedConfigurationProvider.xml

  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.Equals(System.Object)'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.GetHashCode'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.GetType'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.MemberwiseClone'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.ToString'.

xml/Microsoft.Extensions.Configuration/ConfigurationRoot.xml

  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.Equals(System.Object)'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.GetHashCode'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.GetType'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.MemberwiseClone'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.ToString'.

xml/Microsoft.Extensions.Configuration/FileConfigurationProvider.xml

  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.Equals(System.Object)'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.GetHashCode'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.GetType'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.MemberwiseClone'.

xml/Microsoft.Extensions.DependencyInjection/DefaultServiceProviderFactory.xml

  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.Equals(System.Object)'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.GetHashCode'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.GetType'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.MemberwiseClone'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.ToString'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Microsoft.Extensions.DependencyInjection.ServiceProviderOptions.Default'.

xml/Microsoft.Extensions.DependencyInjection/ServiceCollection.xml

  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.Equals(System.Object)'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.GetHashCode'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.GetType'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.MemberwiseClone'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.ToString'.

xml/Microsoft.Extensions.DependencyInjection/ServiceProvider.xml

  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.Equals(System.Object)'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.GetHashCode'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.GetType'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.MemberwiseClone'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.ToString'.

For more details, please refer to the build report.

If you see build warnings/errors with permission issues, it might be due to single sign-on (SSO) enabled on Microsoft's GitHub organizations. Please follow instructions here to re-authorize your GitHub account to Docs Build.

Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report.

Note: Your PR may contain errors or warnings unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

For any questions, please:

@maryamariyan @carlossanlop @gewarren
Apply suggestions from code review
5aa4d00 
Applies PR feedback

Co-authored-by: Carlos Sanchez <1175054+carlossanlop@users.noreply.github.com>
Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com>
@opbld34
Copy link

opbld34 commented Sep 2, 2020

Docs Build status updates of commit 5aa4d00:

⚠️ Validation status: warnings

File Status Preview URL Details
xml/Microsoft.Extensions.Caching.Memory/MemoryCache.xml ⚠️Warning View Details
xml/Microsoft.Extensions.Caching.Memory/MemoryCacheOptions.xml ⚠️Warning View Details
xml/Microsoft.Extensions.Configuration/ChainedConfigurationProvider.xml ⚠️Warning View Details
xml/Microsoft.Extensions.Configuration/ConfigurationRoot.xml ⚠️Warning View Details
xml/Microsoft.Extensions.Configuration/FileConfigurationProvider.xml ⚠️Warning View Details
xml/Microsoft.Extensions.DependencyInjection/DefaultServiceProviderFactory.xml ⚠️Warning View Details
xml/Microsoft.Extensions.DependencyInjection/ServiceCollection.xml ⚠️Warning View Details
xml/Microsoft.Extensions.DependencyInjection/ServiceProvider.xml ⚠️Warning View Details

xml/Microsoft.Extensions.Caching.Memory/MemoryCache.xml

  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.Equals(System.Object)'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.GetHashCode'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.GetType'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.MemberwiseClone'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.ToString'.

xml/Microsoft.Extensions.Caching.Memory/MemoryCacheOptions.xml

  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Microsoft.Extensions.Internal.ISystemClock'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.Equals(System.Object)'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.GetHashCode'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.GetType'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.MemberwiseClone'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.ToString'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.ObsoleteAttribute'.

xml/Microsoft.Extensions.Configuration/ChainedConfigurationProvider.xml

  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.Equals(System.Object)'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.GetHashCode'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.GetType'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.MemberwiseClone'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.ToString'.

xml/Microsoft.Extensions.Configuration/ConfigurationRoot.xml

  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.Equals(System.Object)'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.GetHashCode'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.GetType'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.MemberwiseClone'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.ToString'.

xml/Microsoft.Extensions.Configuration/FileConfigurationProvider.xml

  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.Equals(System.Object)'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.GetHashCode'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.GetType'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.MemberwiseClone'.

xml/Microsoft.Extensions.DependencyInjection/DefaultServiceProviderFactory.xml

  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.Equals(System.Object)'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.GetHashCode'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.GetType'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.MemberwiseClone'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.ToString'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Microsoft.Extensions.DependencyInjection.ServiceProviderOptions.Default'.

xml/Microsoft.Extensions.DependencyInjection/ServiceCollection.xml

  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.Equals(System.Object)'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.GetHashCode'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.GetType'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.MemberwiseClone'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.ToString'.

xml/Microsoft.Extensions.DependencyInjection/ServiceProvider.xml

  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.Equals(System.Object)'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.GetHashCode'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.GetType'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.MemberwiseClone'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Object.ToString'.

For more details, please refer to the build report.

If you see build warnings/errors with permission issues, it might be due to single sign-on (SSO) enabled on Microsoft's GitHub organizations. Please follow instructions here to re-authorize your GitHub account to Docs Build.

Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report.

Note: Your PR may contain errors or warnings unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

For any questions, please:

carlossanlop
carlossanlop approved these changes Sep 2, 2020
View reviewed changes
Copy link
Contributor

@carlossanlop carlossanlop left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

From our conversation, the rest of the undoc APIs can be addressed later.

@carlossanlop
Copy link
Contributor

The warnings are a known issue in the CI, they don't seem to be caused by the changes in this PR, so we can merge.

cc @joelmartinez @TianqiZhang

@carlossanlop carlossanlop merged commit 299da9f into dotnet:master Sep 2, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@gewarren gewarren gewarren left review comments

+1 more reviewer

@carlossanlop carlossanlop carlossanlop approved these changes

Reviewers whose approvals may not affect merge requirements
Assignees
No one assigned
Labels
area-Extensions-Caching area-Extensions-Configuration area-Extensions-DependencyInjection
Projects
None yet
Milestone
June 2020
Development

Successfully merging this pull request may close these issues.
7 participants
@maryamariyan @opbld33 @opbld34 @carlossanlop @gewarren @BillWagner @dotnet-bot