Skip to content
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.

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

API documentation debt - Microsoft.Extensions.DiagnosticAdapter #43898

Closed
Tracked by #43849
carlossanlop opened this issue Oct 27, 2020 · 7 comments
Closed
Tracked by #43849

API documentation debt - Microsoft.Extensions.DiagnosticAdapter #43898

carlossanlop opened this issue Oct 27, 2020 · 7 comments
Labels
area-Meta documentation Documentation bug or enhancement, does not impact product or test code help wanted [up-for-grabs] Good issue for external contributors
Milestone

Comments

@carlossanlop
Copy link
Member

Area owners: @maryamariyan

The APIs in the list below are missing some or all of their documentation. Please add the missing documentation directly in triple slash comments in source. We will make sure it gets ported to dotnet-api-docs after it's merged.

Make sure to follow the documentation guidelines defined in the dotnet-api-docs wiki:
https://github.com/dotnet/dotnet-api-docs/wiki

Also please add me as a PR reviewer.

Community contributions are welcome.

Microsoft.Extensions.DiagnosticAdapter
DocId Summary Parameters TypeParameters ReturnValue Source File Path Docs URL
Microsoft.Extensions.DiagnosticAdapter namespace Missing NA NA NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/ns-Microsoft.Extensions.DiagnosticAdapter.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.DiagnosticAdapter?branch=master
Microsoft.Extensions.DiagnosticAdapter.Infrastructure namespace Missing NA NA NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/ns-Microsoft.Extensions.DiagnosticAdapter.Infrastructure.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.DiagnosticAdapter.Infrastructure?branch=master
M:Microsoft.Extensions.DiagnosticAdapter.DiagnosticNameAttribute.#ctor(System.String) Missing Missing NA NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.DiagnosticAdapter/DiagnosticNameAttribute.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.DiagnosticAdapter.DiagnosticNameAttribute.-ctor?branch=master
M:Microsoft.Extensions.DiagnosticAdapter.DiagnosticSourceAdapter.#ctor(System.Object) Missing Missing NA NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.DiagnosticAdapter/DiagnosticSourceAdapter.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.DiagnosticAdapter.DiagnosticSourceAdapter.-ctor?branch=master
M:Microsoft.Extensions.DiagnosticAdapter.DiagnosticSourceAdapter.#ctor
(System.Object,System.Func{System.String,System.Boolean})
Missing Missing NA NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.DiagnosticAdapter/DiagnosticSourceAdapter.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.DiagnosticAdapter.DiagnosticSourceAdapter.-ctor?branch=master
M:Microsoft.Extensions.DiagnosticAdapter.DiagnosticSourceAdapter.#ctor
(System.Object,System.Func{System.String,System.Boolean},
Microsoft.Extensions.DiagnosticAdapter.IDiagnosticSourceMethodAdapter)
Missing Missing NA NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.DiagnosticAdapter/DiagnosticSourceAdapter.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.DiagnosticAdapter.DiagnosticSourceAdapter.-ctor?branch=master
M:Microsoft.Extensions.DiagnosticAdapter.DiagnosticSourceAdapter.#ctor
(System.Object,System.Func{System.String,System.Object,System.Object,System.Boolean})
Missing Missing NA NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.DiagnosticAdapter/DiagnosticSourceAdapter.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.DiagnosticAdapter.DiagnosticSourceAdapter.-ctor?branch=master
M:Microsoft.Extensions.DiagnosticAdapter.DiagnosticSourceAdapter.#ctor
(System.Object,System.Func{System.String,System.Object,System.Object,System.Boolean},
Microsoft.Extensions.DiagnosticAdapter.IDiagnosticSourceMethodAdapter)
Missing Missing NA NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.DiagnosticAdapter/DiagnosticSourceAdapter.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.DiagnosticAdapter.DiagnosticSourceAdapter.-ctor?branch=master
M:Microsoft.Extensions.DiagnosticAdapter.DiagnosticSourceAdapter.IsEnabled(System.String) Missing Missing NA Missing https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.DiagnosticAdapter/DiagnosticSourceAdapter.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.DiagnosticAdapter.DiagnosticSourceAdapter.IsEnabled?branch=master
M:Microsoft.Extensions.DiagnosticAdapter.DiagnosticSourceAdapter.IsEnabled
(System.String,System.Object,System.Object)
Missing Missing NA Missing https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.DiagnosticAdapter/DiagnosticSourceAdapter.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.DiagnosticAdapter.DiagnosticSourceAdapter.IsEnabled?branch=master
M:Microsoft.Extensions.DiagnosticAdapter.DiagnosticSourceAdapter.Write
(System.String,System.Object)
Missing Missing NA NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.DiagnosticAdapter/DiagnosticSourceAdapter.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.DiagnosticAdapter.DiagnosticSourceAdapter.Write?branch=master
M:Microsoft.Extensions.DiagnosticAdapter.IDiagnosticSourceMethodAdapter.Adapt
(System.Reflection.MethodInfo,System.Type)
Missing Missing NA Missing https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.DiagnosticAdapter/IDiagnosticSourceMethodAdapter.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.DiagnosticAdapter.IDiagnosticSourceMethodAdapter.Adapt?branch=master
M:Microsoft.Extensions.DiagnosticAdapter.ProxyDiagnosticSourceMethodAdapter.#ctor Missing NA NA NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.DiagnosticAdapter/ProxyDiagnosticSourceMethodAdapter.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.DiagnosticAdapter.ProxyDiagnosticSourceMethodAdapter.-ctor?branch=master
M:Microsoft.Extensions.DiagnosticAdapter.ProxyDiagnosticSourceMethodAdapter.Adapt
(System.Reflection.MethodInfo,System.Type)
Missing Missing NA Missing https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.DiagnosticAdapter/ProxyDiagnosticSourceMethodAdapter.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.DiagnosticAdapter.ProxyDiagnosticSourceMethodAdapter.Adapt?branch=master
P:Microsoft.Extensions.DiagnosticAdapter.DiagnosticNameAttribute.Name Missing NA NA NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.DiagnosticAdapter/DiagnosticNameAttribute.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.DiagnosticAdapter.DiagnosticNameAttribute.Name?branch=master
T:Microsoft.Extensions.DiagnosticAdapter.DiagnosticNameAttribute Missing NA NA NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.DiagnosticAdapter/DiagnosticNameAttribute.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.DiagnosticAdapter.DiagnosticNameAttribute?branch=master
T:Microsoft.Extensions.DiagnosticAdapter.DiagnosticSourceAdapter Missing NA NA NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.DiagnosticAdapter/DiagnosticSourceAdapter.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.DiagnosticAdapter.DiagnosticSourceAdapter?branch=master
T:Microsoft.Extensions.DiagnosticAdapter.IDiagnosticSourceMethodAdapter Missing NA NA NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.DiagnosticAdapter/IDiagnosticSourceMethodAdapter.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.DiagnosticAdapter.IDiagnosticSourceMethodAdapter?branch=master
T:Microsoft.Extensions.DiagnosticAdapter.ProxyDiagnosticSourceMethodAdapter Missing NA NA NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.DiagnosticAdapter/ProxyDiagnosticSourceMethodAdapter.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.DiagnosticAdapter.ProxyDiagnosticSourceMethodAdapter?branch=master

Notes:

  • The namespaces need to be documented directly in dotnet-api-docs.
  • Some of the APIs are obsolete, so I'll let area owners decide if they want to still document them or skip them. If you opt for documenting them, please do it directly in dotnet-api-docs.
@carlossanlop carlossanlop added documentation Documentation bug or enhancement, does not impact product or test code help wanted [up-for-grabs] Good issue for external contributors untriaged New issue has not been triaged by the area owner area-Microsoft.Extensions labels Oct 27, 2020
@carlossanlop carlossanlop added this to the 6.0.0 milestone Oct 27, 2020
@maryamariyan
Copy link
Member

In dotnet/extensions/README.md is listed as no longer shipping for 5.0

@buyaa-n
Copy link
Contributor

buyaa-n commented Jul 7, 2021

In dotnet/extensions/README.md is listed as no longer shipping for 5.0

@maryamariyan is that means this issue can be closed? Why did you remove area-Microsoft.Extensions looks it should be in that area not in Meta

@buyaa-n buyaa-n removed the untriaged New issue has not been triaged by the area owner label Jul 7, 2021
@krwq krwq modified the milestones: 6.0.0, 7.0.0 Jul 19, 2021
@jerviscui
Copy link

jerviscui commented Dec 23, 2021

How about Microsoft.Extensions.DiagnosticAdapter?
Obsolescence or No longer update?

@carlossanlop

@danmoseley
Copy link
Member

@jerviscui per aspnet/Announcements#411, that component is no longer being updated.

@jerviscui
Copy link

@danmoseley Thanks, I see it.
Do I give up using Diagnostic?
Change to EventCounter or System.Diagnostics.Metrics?

@danmoseley
Copy link
Member

@maryamariyan can you advise?

@ghost ghost locked as resolved and limited conversation to collaborators Feb 4, 2022
@xakep139
Copy link
Contributor

xakep139 commented Feb 8, 2023

@maryamariyan can you advise?

Kind ping here. What's the destiny of Microsoft.Extensions.DiagnosticAdapter package?

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
area-Meta documentation Documentation bug or enhancement, does not impact product or test code help wanted [up-for-grabs] Good issue for external contributors
Projects
No open projects
Development

No branches or pull requests

8 participants