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.

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

Undocumented 7.0 APIs as of RC2 #76049

Open
carlossanlop opened this issue Sep 23, 2022 · 8 comments
Open

Undocumented 7.0 APIs as of RC2 #76049

carlossanlop opened this issue Sep 23, 2022 · 8 comments
Labels
area-Meta documentation Documentation bug or enhancement, does not impact product or test code
Milestone
10.0.0

Comments

@carlossanlop
Copy link
Member

There are still 253 APIs left to document for 7.0.

You have two options for documenting them:

  • Add the missing texts directly in the dotnet-api-docs xml file (preferred, faster).
  • Add the triple slash comments in dotnet/runtime, then use the PortToDocs.exe tool from dotnet/api-docs-sync to port them to dotnet-api-docs, then open PRs for both.

These need to get documented before the GA snap, which will happen on October 10th.

There were still some open issues. I updated their lists:

The rest of the undoc APIs are listed below:

System.Data

@ajcvickers @DavoudEshtehari @David-Engel

API Summary Parameters TypeParameters ReturnValue
M:System.Data.SqlTypes.SqlBinary.WrapBytes(System.Byte[]) Missing Missing NA Missing
M:System.Data.SqlTypes.SqlDecimal.WriteTdsValue(System.Span{System.UInt32}) Missing Missing NA Missing
M:System.Data.SqlTypes.SqlMoney.FromTdsValue(System.Int64) Missing Missing NA Missing
M:System.Data.SqlTypes.SqlMoney.GetTdsValue Missing NA NA Missing
System.Diagnostics

@tommcdon @tarekgh @maryamariyan @eerhardt

API Summary Parameters TypeParameters ReturnValue
M:System.Diagnostics.InitializingSwitchEventArgs.#ctor(System.Diagnostics.Switch) Missing Missing NA NA
P:System.Diagnostics.InitializingSwitchEventArgs.Switch Missing NA NA NA
M:System.Diagnostics.InitializingTraceSourceEventArgs.#ctor(System.Diagnostics.TraceSource) Missing Missing NA NA
P:System.Diagnostics.InitializingTraceSourceEventArgs.TraceSource Missing NA NA NA
P:System.Diagnostics.InitializingTraceSourceEventArgs.WasInitialized Missing NA NA NA
T:System.Diagnostics.TraceConfiguration Missing NA NA NA
System.Reflection.Metadata.Ecma335

@ericstj @dotnet/area-system-reflection-metadata

API Summary Parameters TypeParameters ReturnValue
M:System.Reflection.Metadata.Ecma335.FieldTypeEncoder.CustomModifiers Present NA NA Missing
System.Runtime.Serialization.DataContracts

@HongGit @StephenMolloy

API Summary Parameters TypeParameters ReturnValue
N:System.Runtime.Serialization.DataContracts Missing NA NA NA
P:System.Runtime.Serialization.DataContracts.DataContract.BaseContract Missing NA NA NA
P:System.Runtime.Serialization.DataContracts.DataContract.ContractType Missing NA NA NA
T:System.Runtime.Serialization.DataContracts.DataContract Missing NA NA NA
P:System.Runtime.Serialization.DataContracts.DataContract.DataMembers Missing NA NA NA
M:System.Runtime.Serialization.DataContracts.DataContract.GetArrayTypeName(System.Boolean) Missing Missing NA Missing
M:System.Runtime.Serialization.DataContracts.DataContract.GetBuiltInDataContract(System.String,System.String) Missing Missing NA Missing
M:System.Runtime.Serialization.DataContracts.DataContract.GetXmlName(System.Type) Missing Missing NA Missing
P:System.Runtime.Serialization.DataContracts.DataContract.IsBuiltInDataContract Missing NA NA NA
M:System.Runtime.Serialization.DataContracts.DataContract.IsDictionaryLike(System.String@,System.String@,System.String@) Missing Missing NA Missing
P:System.Runtime.Serialization.DataContracts.DataContract.IsISerializable Missing NA NA NA
P:System.Runtime.Serialization.DataContracts.DataContract.IsReference Missing NA NA NA
P:System.Runtime.Serialization.DataContracts.DataContract.IsValueType Missing NA NA NA
P:System.Runtime.Serialization.DataContracts.DataContract.KnownDataContracts Missing NA NA NA
P:System.Runtime.Serialization.DataContracts.DataContract.OriginalUnderlyingType Missing NA NA NA
P:System.Runtime.Serialization.DataContracts.DataContract.TopLevelElementName Missing NA NA NA
P:System.Runtime.Serialization.DataContracts.DataContract.TopLevelElementNamespace Missing NA NA NA
P:System.Runtime.Serialization.DataContracts.DataContract.UnderlyingType Missing NA NA NA
P:System.Runtime.Serialization.DataContracts.DataContract.XmlName Missing NA NA NA
M:System.Runtime.Serialization.DataContracts.DataContractSet.#ctor(System.Runtime.Serialization.DataContracts.DataContractSet) Missing Missing NA NA
M:System.Runtime.Serialization.DataContracts.DataContractSet.#ctor(System.Runtime.Serialization.ISerializationSurrogateProvider,System.Collections.Generic.IEnumerable{System.Type},System.Collections.Generic.IEnumerable{System.Type}) Missing Missing NA NA
P:System.Runtime.Serialization.DataContracts.DataContractSet.Contracts Missing NA NA NA
T:System.Runtime.Serialization.DataContracts.DataContractSet Missing NA NA NA
M:System.Runtime.Serialization.DataContracts.DataContractSet.GetDataContract(System.Type) Missing Missing NA Missing
M:System.Runtime.Serialization.DataContracts.DataContractSet.GetDataContract(System.Xml.XmlQualifiedName) Missing Missing NA Missing
M:System.Runtime.Serialization.DataContracts.DataContractSet.GetReferencedType(System.Xml.XmlQualifiedName,System.Runtime.Serialization.DataContracts.DataContract,System.Runtime.Serialization.DataContracts.DataContract@,System.Object[]@,System.Nullable{System.Boolean}) Missing Missing NA Missing
M:System.Runtime.Serialization.DataContracts.DataContractSet.ImportSchemaSet(System.Xml.Schema.XmlSchemaSet,System.Collections.Generic.IEnumerable{System.Xml.Schema.XmlSchemaElement},System.Boolean) Missing Missing NA Missing
M:System.Runtime.Serialization.DataContracts.DataContractSet.ImportSchemaSet(System.Xml.Schema.XmlSchemaSet,System.Collections.Generic.IEnumerable{System.Xml.XmlQualifiedName},System.Boolean) Missing Missing NA NA
P:System.Runtime.Serialization.DataContracts.DataContractSet.KnownTypesForObject Missing NA NA NA
P:System.Runtime.Serialization.DataContracts.DataContractSet.ProcessedContracts Missing NA NA NA
P:System.Runtime.Serialization.DataContracts.DataContractSet.SurrogateData Missing NA NA NA
T:System.Runtime.Serialization.DataContracts.DataMember Missing NA NA NA
P:System.Runtime.Serialization.DataContracts.DataMember.EmitDefaultValue Missing NA NA NA
P:System.Runtime.Serialization.DataContracts.DataMember.IsNullable Missing NA NA NA
P:System.Runtime.Serialization.DataContracts.DataMember.IsRequired Missing NA NA NA
P:System.Runtime.Serialization.DataContracts.DataMember.MemberTypeContract Missing NA NA NA
P:System.Runtime.Serialization.DataContracts.DataMember.Name Missing NA NA NA
P:System.Runtime.Serialization.DataContracts.DataMember.Order Missing NA NA NA
P:System.Runtime.Serialization.DataContracts.XmlDataContract.HasRoot Missing NA NA NA
P:System.Runtime.Serialization.DataContracts.XmlDataContract.IsAnonymous Missing NA NA NA
P:System.Runtime.Serialization.DataContracts.XmlDataContract.IsTopLevelElementNullable Missing NA NA NA
P:System.Runtime.Serialization.DataContracts.XmlDataContract.IsTypeDefinedOnImport Missing NA NA NA
P:System.Runtime.Serialization.DataContracts.XmlDataContract.IsValueType Missing NA NA NA
T:System.Runtime.Serialization.DataContracts.XmlDataContract Missing NA NA NA
P:System.Runtime.Serialization.DataContracts.XmlDataContract.XsdType Missing NA NA NA
System.Runtime.Serialization.Json

@HongGit @StephenMolloy

API Summary Parameters TypeParameters ReturnValue
M:System.Runtime.Serialization.Json.DataContractJsonSerializer.GetSerializationSurrogateProvider Missing NA NA Missing
M:System.Runtime.Serialization.Json.DataContractJsonSerializer.SetSerializationSurrogateProvider(System.Runtime.Serialization.ISerializationSurrogateProvider) Missing Missing NA NA
System.Runtime.Versioning

@jeffhandley @buyaa-n

API Summary Parameters TypeParameters ReturnValue
M:System.Runtime.Versioning.ObsoletedOSPlatformAttribute.#ctor(System.String,System.String) Missing Missing NA NA
M:System.Runtime.Versioning.ObsoletedOSPlatformAttribute.#ctor(System.String) Missing Missing NA NA
P:System.Runtime.Versioning.ObsoletedOSPlatformAttribute.Message Missing NA NA NA
P:System.Runtime.Versioning.ObsoletedOSPlatformAttribute.Url Missing NA NA NA
System.Security.Cryptography

@dotnet/area-system-security

API Summary Parameters TypeParameters ReturnValue
M:System.Security.Cryptography.ECDsaCng.TrySignHash(System.ReadOnlySpan{System.Byte},System.Span{System.Byte},System.Int32@) Present Missing NA Present
M:System.Security.Cryptography.RSACng.TryDecrypt(System.ReadOnlySpan{System.Byte},System.Span{System.Byte},System.Security.Cryptography.RSAEncryptionPadding,System.Int32@) Present Missing NA Missing
M:System.Security.Cryptography.RSACng.TryEncrypt(System.ReadOnlySpan{System.Byte},System.Span{System.Byte},System.Security.Cryptography.RSAEncryptionPadding,System.Int32@) Present Missing NA Missing
M:System.Security.Cryptography.Cose.CoseHeaderMap.TryGetValue(System.Security.Cryptography.Cose.CoseHeaderLabel,System.Security.Cryptography.Cose.CoseHeaderValue@) Missing Missing NA Missing
M:System.Security.Cryptography.X509Certificates.CertificateRequest.CreateSigningRequestPem Present NA NA Missing
M:System.Security.Cryptography.X509Certificates.CertificateRequest.CreateSigningRequestPem(System.Security.Cryptography.X509Certificates.X509SignatureGenerator) Present Present NA Missing
M:System.Security.Cryptography.X509Certificates.CertificateRequest.LoadSigningRequest(System.ReadOnlySpan{System.Byte},System.Security.Cryptography.HashAlgorithmName,System.Int32@,System.Security.Cryptography.X509Certificates.CertificateRequestLoadOptions,System.Security.Cryptography.RSASignaturePadding) Missing Missing NA Missing
M:System.Security.Cryptography.X509Certificates.CertificateRequest.LoadSigningRequest(System.Byte[],System.Security.Cryptography.HashAlgorithmName,System.Security.Cryptography.X509Certificates.CertificateRequestLoadOptions,System.Security.Cryptography.RSASignaturePadding) Missing Missing NA Missing
M:System.Security.Cryptography.X509Certificates.CertificateRequest.LoadSigningRequestPem(System.ReadOnlySpan{System.Char},System.Security.Cryptography.HashAlgorithmName,System.Security.Cryptography.X509Certificates.CertificateRequestLoadOptions,System.Security.Cryptography.RSASignaturePadding) Missing Missing NA Missing
M:System.Security.Cryptography.X509Certificates.CertificateRequest.LoadSigningRequestPem(System.String,System.Security.Cryptography.HashAlgorithmName,System.Security.Cryptography.X509Certificates.CertificateRequestLoadOptions,System.Security.Cryptography.RSASignaturePadding) Missing Missing NA Missing
M:System.Security.Cryptography.X509Certificates.X500RelativeDistinguishedName.GetSingleElementType Present NA NA Missing
M:System.Security.Cryptography.X509Certificates.X509SubjectAlternativeNameExtension.#ctor(System.ReadOnlySpan{System.Byte},System.Boolean) Missing Missing NA NA
M:System.Security.Cryptography.X509Certificates.X509SubjectAlternativeNameExtension.#ctor(System.Byte[],System.Boolean) Missing Missing NA NA
M:System.Security.Cryptography.X509Certificates.X509SubjectAlternativeNameExtension.#ctor Missing NA NA NA
M:System.Security.Cryptography.X509Certificates.X509SubjectAlternativeNameExtension.CopyFrom(System.Security.Cryptography.AsnEncodedData) Missing Missing NA NA
M:System.Security.Cryptography.X509Certificates.X509SubjectAlternativeNameExtension.EnumerateDnsNames Missing NA NA Missing
M:System.Security.Cryptography.X509Certificates.X509SubjectAlternativeNameExtension.EnumerateIPAddresses Missing NA NA Missing
T:System.Security.Cryptography.X509Certificates.X509SubjectAlternativeNameExtension Missing NA NA NA
System.Text.Json.Serialization

@dotnet/area-system-text-json

API Summary Parameters TypeParameters ReturnValue
M:System.Text.Json.Serialization.Metadata.JsonPolymorphismOptions.#ctor Missing NA NA NA
@carlossanlop carlossanlop added documentation Documentation bug or enhancement, does not impact product or test code area-Meta labels Sep 23, 2022
@carlossanlop carlossanlop added this to the 7.0.0 milestone Sep 23, 2022
@ghost
Copy link

ghost commented Sep 23, 2022

Tagging subscribers to this area: @dotnet/area-meta
See info in area-owners.md if you want to be subscribed.

Issue Details

There are still 253 APIs left to document for 7.0.

You have two options for documenting them:

  • Add the missing texts directly in the dotnet-api-docs xml file (preferred, faster).
  • Add the triple slash comments in dotnet/runtime, then use the PortToDocs.exe tool from dotnet/api-docs-sync to port them to dotnet-api-docs, then open PRs for both.

These need to get documented before the GA snap, which will happen on October 10th.

There were still some open issues. I updated their lists:

The rest of the undoc APIs are listed below:

System.Data

@ajcvickers @DavoudEshtehari @David-Engel

API Summary Parameters TypeParameters ReturnValue
M:System.Data.SqlTypes.SqlBinary.WrapBytes(System.Byte[]) Missing Missing NA Missing
M:System.Data.SqlTypes.SqlDecimal.WriteTdsValue(System.Span{System.UInt32}) Missing Missing NA Missing
M:System.Data.SqlTypes.SqlMoney.FromTdsValue(System.Int64) Missing Missing NA Missing
M:System.Data.SqlTypes.SqlMoney.GetTdsValue Missing NA NA Missing
System.Diagnostics

@tommcdon @tarekgh @maryamariyan @eerhardt

API Summary Parameters TypeParameters ReturnValue
M:System.Diagnostics.InitializingSwitchEventArgs.#ctor(System.Diagnostics.Switch) Missing Missing NA NA
P:System.Diagnostics.InitializingSwitchEventArgs.Switch Missing NA NA NA
M:System.Diagnostics.InitializingTraceSourceEventArgs.#ctor(System.Diagnostics.TraceSource) Missing Missing NA NA
P:System.Diagnostics.InitializingTraceSourceEventArgs.TraceSource Missing NA NA NA
P:System.Diagnostics.InitializingTraceSourceEventArgs.WasInitialized Missing NA NA NA
T:System.Diagnostics.TraceConfiguration Missing NA NA NA
System.Reflection.Metadata.Ecma335

@ericstj @dotnet/area-system-reflection-metadata

API Summary Parameters TypeParameters ReturnValue
M:System.Reflection.Metadata.Ecma335.FieldTypeEncoder.CustomModifiers Present NA NA Missing
System.Runtime.Serialization.DataContracts

@HongGit @StephenMolloy

API Summary Parameters TypeParameters ReturnValue
N:System.Runtime.Serialization.DataContracts Missing NA NA NA
P:System.Runtime.Serialization.DataContracts.DataContract.BaseContract Missing NA NA NA
P:System.Runtime.Serialization.DataContracts.DataContract.ContractType Missing NA NA NA
T:System.Runtime.Serialization.DataContracts.DataContract Missing NA NA NA
P:System.Runtime.Serialization.DataContracts.DataContract.DataMembers Missing NA NA NA
M:System.Runtime.Serialization.DataContracts.DataContract.GetArrayTypeName(System.Boolean) Missing Missing NA Missing
M:System.Runtime.Serialization.DataContracts.DataContract.GetBuiltInDataContract(System.String,System.String) Missing Missing NA Missing
M:System.Runtime.Serialization.DataContracts.DataContract.GetXmlName(System.Type) Missing Missing NA Missing
P:System.Runtime.Serialization.DataContracts.DataContract.IsBuiltInDataContract Missing NA NA NA
M:System.Runtime.Serialization.DataContracts.DataContract.IsDictionaryLike(System.String@,System.String@,System.String@) Missing Missing NA Missing
P:System.Runtime.Serialization.DataContracts.DataContract.IsISerializable Missing NA NA NA
P:System.Runtime.Serialization.DataContracts.DataContract.IsReference Missing NA NA NA
P:System.Runtime.Serialization.DataContracts.DataContract.IsValueType Missing NA NA NA
P:System.Runtime.Serialization.DataContracts.DataContract.KnownDataContracts Missing NA NA NA
P:System.Runtime.Serialization.DataContracts.DataContract.OriginalUnderlyingType Missing NA NA NA
P:System.Runtime.Serialization.DataContracts.DataContract.TopLevelElementName Missing NA NA NA
P:System.Runtime.Serialization.DataContracts.DataContract.TopLevelElementNamespace Missing NA NA NA
P:System.Runtime.Serialization.DataContracts.DataContract.UnderlyingType Missing NA NA NA
P:System.Runtime.Serialization.DataContracts.DataContract.XmlName Missing NA NA NA
M:System.Runtime.Serialization.DataContracts.DataContractSet.#ctor(System.Runtime.Serialization.DataContracts.DataContractSet) Missing Missing NA NA
M:System.Runtime.Serialization.DataContracts.DataContractSet.#ctor(System.Runtime.Serialization.ISerializationSurrogateProvider,System.Collections.Generic.IEnumerable{System.Type},System.Collections.Generic.IEnumerable{System.Type}) Missing Missing NA NA
P:System.Runtime.Serialization.DataContracts.DataContractSet.Contracts Missing NA NA NA
T:System.Runtime.Serialization.DataContracts.DataContractSet Missing NA NA NA
M:System.Runtime.Serialization.DataContracts.DataContractSet.GetDataContract(System.Type) Missing Missing NA Missing
M:System.Runtime.Serialization.DataContracts.DataContractSet.GetDataContract(System.Xml.XmlQualifiedName) Missing Missing NA Missing
M:System.Runtime.Serialization.DataContracts.DataContractSet.GetReferencedType(System.Xml.XmlQualifiedName,System.Runtime.Serialization.DataContracts.DataContract,System.Runtime.Serialization.DataContracts.DataContract@,System.Object[]@,System.Nullable{System.Boolean}) Missing Missing NA Missing
M:System.Runtime.Serialization.DataContracts.DataContractSet.ImportSchemaSet(System.Xml.Schema.XmlSchemaSet,System.Collections.Generic.IEnumerable{System.Xml.Schema.XmlSchemaElement},System.Boolean) Missing Missing NA Missing
M:System.Runtime.Serialization.DataContracts.DataContractSet.ImportSchemaSet(System.Xml.Schema.XmlSchemaSet,System.Collections.Generic.IEnumerable{System.Xml.XmlQualifiedName},System.Boolean) Missing Missing NA NA
P:System.Runtime.Serialization.DataContracts.DataContractSet.KnownTypesForObject Missing NA NA NA
P:System.Runtime.Serialization.DataContracts.DataContractSet.ProcessedContracts Missing NA NA NA
P:System.Runtime.Serialization.DataContracts.DataContractSet.SurrogateData Missing NA NA NA
T:System.Runtime.Serialization.DataContracts.DataMember Missing NA NA NA
P:System.Runtime.Serialization.DataContracts.DataMember.EmitDefaultValue Missing NA NA NA
P:System.Runtime.Serialization.DataContracts.DataMember.IsNullable Missing NA NA NA
P:System.Runtime.Serialization.DataContracts.DataMember.IsRequired Missing NA NA NA
P:System.Runtime.Serialization.DataContracts.DataMember.MemberTypeContract Missing NA NA NA
P:System.Runtime.Serialization.DataContracts.DataMember.Name Missing NA NA NA
P:System.Runtime.Serialization.DataContracts.DataMember.Order Missing NA NA NA
P:System.Runtime.Serialization.DataContracts.XmlDataContract.HasRoot Missing NA NA NA
P:System.Runtime.Serialization.DataContracts.XmlDataContract.IsAnonymous Missing NA NA NA
P:System.Runtime.Serialization.DataContracts.XmlDataContract.IsTopLevelElementNullable Missing NA NA NA
P:System.Runtime.Serialization.DataContracts.XmlDataContract.IsTypeDefinedOnImport Missing NA NA NA
P:System.Runtime.Serialization.DataContracts.XmlDataContract.IsValueType Missing NA NA NA
T:System.Runtime.Serialization.DataContracts.XmlDataContract Missing NA NA NA
P:System.Runtime.Serialization.DataContracts.XmlDataContract.XsdType Missing NA NA NA
System.Runtime.Serialization.Json

@HongGit @StephenMolloy

API Summary Parameters TypeParameters ReturnValue
M:System.Runtime.Serialization.Json.DataContractJsonSerializer.GetSerializationSurrogateProvider Missing NA NA Missing
M:System.Runtime.Serialization.Json.DataContractJsonSerializer.SetSerializationSurrogateProvider(System.Runtime.Serialization.ISerializationSurrogateProvider) Missing Missing NA NA
System.Runtime.Versioning

@jeffhandley @buyaa-n

API Summary Parameters TypeParameters ReturnValue
M:System.Runtime.Versioning.ObsoletedOSPlatformAttribute.#ctor(System.String,System.String) Missing Missing NA NA
M:System.Runtime.Versioning.ObsoletedOSPlatformAttribute.#ctor(System.String) Missing Missing NA NA
P:System.Runtime.Versioning.ObsoletedOSPlatformAttribute.Message Missing NA NA NA
P:System.Runtime.Versioning.ObsoletedOSPlatformAttribute.Url Missing NA NA NA
System.Security.Cryptography

@dotnet/area-system-security

API Summary Parameters TypeParameters ReturnValue
M:System.Security.Cryptography.ECDsaCng.TrySignHash(System.ReadOnlySpan{System.Byte},System.Span{System.Byte},System.Int32@) Present Missing NA Present
M:System.Security.Cryptography.RSACng.TryDecrypt(System.ReadOnlySpan{System.Byte},System.Span{System.Byte},System.Security.Cryptography.RSAEncryptionPadding,System.Int32@) Present Missing NA Missing
M:System.Security.Cryptography.RSACng.TryEncrypt(System.ReadOnlySpan{System.Byte},System.Span{System.Byte},System.Security.Cryptography.RSAEncryptionPadding,System.Int32@) Present Missing NA Missing
M:System.Security.Cryptography.Cose.CoseHeaderMap.TryGetValue(System.Security.Cryptography.Cose.CoseHeaderLabel,System.Security.Cryptography.Cose.CoseHeaderValue@) Missing Missing NA Missing
M:System.Security.Cryptography.X509Certificates.CertificateRequest.CreateSigningRequestPem Present NA NA Missing
M:System.Security.Cryptography.X509Certificates.CertificateRequest.CreateSigningRequestPem(System.Security.Cryptography.X509Certificates.X509SignatureGenerator) Present Present NA Missing
M:System.Security.Cryptography.X509Certificates.CertificateRequest.LoadSigningRequest(System.ReadOnlySpan{System.Byte},System.Security.Cryptography.HashAlgorithmName,System.Int32@,System.Security.Cryptography.X509Certificates.CertificateRequestLoadOptions,System.Security.Cryptography.RSASignaturePadding) Missing Missing NA Missing
M:System.Security.Cryptography.X509Certificates.CertificateRequest.LoadSigningRequest(System.Byte[],System.Security.Cryptography.HashAlgorithmName,System.Security.Cryptography.X509Certificates.CertificateRequestLoadOptions,System.Security.Cryptography.RSASignaturePadding) Missing Missing NA Missing
M:System.Security.Cryptography.X509Certificates.CertificateRequest.LoadSigningRequestPem(System.ReadOnlySpan{System.Char},System.Security.Cryptography.HashAlgorithmName,System.Security.Cryptography.X509Certificates.CertificateRequestLoadOptions,System.Security.Cryptography.RSASignaturePadding) Missing Missing NA Missing
M:System.Security.Cryptography.X509Certificates.CertificateRequest.LoadSigningRequestPem(System.String,System.Security.Cryptography.HashAlgorithmName,System.Security.Cryptography.X509Certificates.CertificateRequestLoadOptions,System.Security.Cryptography.RSASignaturePadding) Missing Missing NA Missing
M:System.Security.Cryptography.X509Certificates.X500RelativeDistinguishedName.GetSingleElementType Present NA NA Missing
M:System.Security.Cryptography.X509Certificates.X509SubjectAlternativeNameExtension.#ctor(System.ReadOnlySpan{System.Byte},System.Boolean) Missing Missing NA NA
M:System.Security.Cryptography.X509Certificates.X509SubjectAlternativeNameExtension.#ctor(System.Byte[],System.Boolean) Missing Missing NA NA
M:System.Security.Cryptography.X509Certificates.X509SubjectAlternativeNameExtension.#ctor Missing NA NA NA
M:System.Security.Cryptography.X509Certificates.X509SubjectAlternativeNameExtension.CopyFrom(System.Security.Cryptography.AsnEncodedData) Missing Missing NA NA
M:System.Security.Cryptography.X509Certificates.X509SubjectAlternativeNameExtension.EnumerateDnsNames Missing NA NA Missing
M:System.Security.Cryptography.X509Certificates.X509SubjectAlternativeNameExtension.EnumerateIPAddresses Missing NA NA Missing
T:System.Security.Cryptography.X509Certificates.X509SubjectAlternativeNameExtension Missing NA NA NA
System.Text.Json.Serialization

@dotnet/area-system-text-json

API Summary Parameters TypeParameters ReturnValue
M:System.Text.Json.Serialization.Metadata.JsonPolymorphismOptions.#ctor Missing NA NA NA
Author: carlossanlop
Assignees: -
Labels:

documentation, area-Meta
Milestone: 7.0.0

@carlossanlop carlossanlop mentioned this issue Sep 23, 2022
Closed
@tarekgh
Copy link
Member

tarekgh commented Sep 23, 2022

@carlossanlop the System.Diagnostics APIs listed here has the owner @tommcdon and @dotnet/area-system-diagnostics-tracesource. Please update that in your comment. Thanks!

@ericstj ericstj mentioned this issue Sep 23, 2022
Merged
@David-Engel David-Engel mentioned this issue Sep 23, 2022
Merged
@buyaa-n buyaa-n mentioned this issue Sep 23, 2022
Merged
@krwq
Copy link
Member

krwq commented Sep 26, 2022 •
edited
Loading

@carlossanlop JsonPolymorphismOptions has implicitly defined constructor. How to properly define XML doc in the code if at all?

@eiriktsarpalis
Copy link
Member

We make it explicit and add XML docs. Honestly, we should probably be doing this consistently for every public class.

This was referenced Sep 26, 2022
Merged
Merged
@carlossanlop
Copy link
Member Author

@carlossanlop JsonPolymorphismOptions has implicitly defined constructor. How to properly define XML doc in the code if at all?

@krwq Yeah, this was brought up recently. I will have to add the fix to the docs porting tool so that it detects implicit constructors and adds a generic boilerplate message. Here's the issue I opened to track this request: dotnet/api-docs-sync#132

We make it explicit and add XML docs. Honestly, we should probably be doing this consistently for every public class.

Yep, that's the current way to get it fixed, @eiriktsarpalis.

@bartonjs bartonjs mentioned this issue Sep 26, 2022
Merged
@carlossanlop carlossanlop changed the title Undocumented 7.0 APIs as of RC1 Undocumented 7.0 APIs as of RC2 Oct 24, 2022
@carlossanlop
Copy link
Member Author

These are the 57 APIs introduced in 7.0 that have yet to be documented:

@tommcdon @dotnet/area-system-diagnostics-tracesource
@dotnet/area-system-runtime
@dotnet/area-system-security

API Summary Parameters TypeParameters ReturnValue
M:System.Diagnostics.InitializingSwitchEventArgs.#ctor(System.Diagnostics.Switch) Missing Missing NA NA
P:System.Diagnostics.InitializingSwitchEventArgs.Switch Missing NA NA NA
M:System.Diagnostics.InitializingTraceSourceEventArgs.#ctor
(System.Diagnostics.TraceSource)		 Missing Missing NA NA
P:System.Diagnostics.InitializingTraceSourceEventArgs.TraceSource Missing NA NA NA
P:System.Diagnostics.InitializingTraceSourceEventArgs.WasInitialized Missing NA NA NA
T:System.Diagnostics.TraceConfiguration Missing NA NA NA
N:System.Runtime.Serialization.DataContracts Missing NA NA NA
P:System.Runtime.Serialization.DataContracts.DataContract.BaseContract Missing NA NA NA
P:System.Runtime.Serialization.DataContracts.DataContract.ContractType Missing NA NA NA
T:System.Runtime.Serialization.DataContracts.DataContract Missing NA NA NA
P:System.Runtime.Serialization.DataContracts.DataContract.DataMembers Missing NA NA NA
M:System.Runtime.Serialization.DataContracts.DataContract.GetArrayTypeName
(System.Boolean)		 Missing Missing NA Missing
M:System.Runtime.Serialization.DataContracts.DataContract.GetBuiltInDataContract
(System.String,System.String)		 Missing Missing NA Missing
M:System.Runtime.Serialization.DataContracts.DataContract.GetXmlName
(System.Type)		 Missing Missing NA Missing
P:System.Runtime.Serialization.DataContracts.DataContract.IsBuiltInDataContract Missing NA NA NA
M:System.Runtime.Serialization.DataContracts.DataContract.IsDictionaryLike
(System.String@,System.String@,System.String@)		 Missing Missing NA Missing
P:System.Runtime.Serialization.DataContracts.DataContract.IsISerializable Missing NA NA NA
P:System.Runtime.Serialization.DataContracts.DataContract.IsReference Missing NA NA NA
P:System.Runtime.Serialization.DataContracts.DataContract.IsValueType Missing NA NA NA
P:System.Runtime.Serialization.DataContracts.DataContract.KnownDataContracts Missing NA NA NA
P:System.Runtime.Serialization.DataContracts.DataContract.OriginalUnderlyingType Missing NA NA NA
P:System.Runtime.Serialization.DataContracts.DataContract.TopLevelElementName Missing NA NA NA
P:System.Runtime.Serialization.DataContracts.DataContract.TopLevelElementNamespace Missing NA NA NA
P:System.Runtime.Serialization.DataContracts.DataContract.UnderlyingType Missing NA NA NA
P:System.Runtime.Serialization.DataContracts.DataContract.XmlName Missing NA NA NA
M:System.Runtime.Serialization.DataContracts.DataContractSet.#ctor
(System.Runtime.Serialization.DataContracts.DataContractSet)		 Missing Missing NA NA
M:System.Runtime.Serialization.DataContracts.DataContractSet.#ctor
(System.Runtime.Serialization.ISerializationSurrogateProvider,System.Collections.Generic.IEnumerable
{System.Type},System.Collections.Generic.IEnumerable{System.Type})		 Missing Missing NA NA
P:System.Runtime.Serialization.DataContracts.DataContractSet.Contracts Missing NA NA NA
T:System.Runtime.Serialization.DataContracts.DataContractSet Missing NA NA NA
M:System.Runtime.Serialization.DataContracts.DataContractSet.GetDataContract
(System.Type)		 Missing Missing NA Missing
M:System.Runtime.Serialization.DataContracts.DataContractSet.GetDataContract
(System.Xml.XmlQualifiedName)		 Missing Missing NA Missing
M:System.Runtime.Serialization.DataContracts.DataContractSet.GetReferencedType
(System.Xml.XmlQualifiedName,System.Runtime.Serialization.DataContracts.DataContract,
System.Runtime.Serialization.DataContracts.DataContract@,System.Object[]@,System.Nullable{System.Boolean})		 Missing Missing NA Missing
M:System.Runtime.Serialization.DataContracts.DataContractSet.ImportSchemaSet
(System.Xml.Schema.XmlSchemaSet,System.Collections.Generic.IEnumerable
{System.Xml.Schema.XmlSchemaElement},System.Boolean)		 Missing Missing NA Missing
M:System.Runtime.Serialization.DataContracts.DataContractSet.ImportSchemaSet
(System.Xml.Schema.XmlSchemaSet,System.Collections.Generic.IEnumerable
{System.Xml.XmlQualifiedName},System.Boolean)		 Missing Missing NA NA
P:System.Runtime.Serialization.DataContracts.DataContractSet.KnownTypesForObject Missing NA NA NA
P:System.Runtime.Serialization.DataContracts.DataContractSet.ProcessedContracts Missing NA NA NA
P:System.Runtime.Serialization.DataContracts.DataContractSet.SurrogateData Missing NA NA NA
T:System.Runtime.Serialization.DataContracts.DataMember Missing NA NA NA
P:System.Runtime.Serialization.DataContracts.DataMember.EmitDefaultValue Missing NA NA NA
P:System.Runtime.Serialization.DataContracts.DataMember.IsNullable Missing NA NA NA
P:System.Runtime.Serialization.DataContracts.DataMember.IsRequired Missing NA NA NA
P:System.Runtime.Serialization.DataContracts.DataMember.MemberTypeContract Missing NA NA NA
P:System.Runtime.Serialization.DataContracts.DataMember.Name Missing NA NA NA
P:System.Runtime.Serialization.DataContracts.DataMember.Order Missing NA NA NA
P:System.Runtime.Serialization.DataContracts.XmlDataContract.HasRoot Missing NA NA NA
P:System.Runtime.Serialization.DataContracts.XmlDataContract.IsAnonymous Missing NA NA NA
P:System.Runtime.Serialization.DataContracts.XmlDataContract.IsTopLevelElementNullable Missing NA NA NA
P:System.Runtime.Serialization.DataContracts.XmlDataContract.IsTypeDefinedOnImport Missing NA NA NA
P:System.Runtime.Serialization.DataContracts.XmlDataContract.IsValueType Missing NA NA NA
T:System.Runtime.Serialization.DataContracts.XmlDataContract Missing NA NA NA
P:System.Runtime.Serialization.DataContracts.XmlDataContract.XsdType Missing NA NA NA
M:System.Runtime.Serialization.Json.DataContractJsonSerializer.GetSerializationSurrogateProvider Missing NA NA Missing
M:System.Runtime.Serialization.Json.DataContractJsonSerializer.SetSerializationSurrogateProvider
(System.Runtime.Serialization.ISerializationSurrogateProvider)		 Missing Missing NA NA
M:System.Security.Cryptography.ECDsaCng.TrySignHash
(System.ReadOnlySpan{System.Byte},System.Span{System.Byte},System.Int32@)		 Present Missing NA Present
M:System.Security.Cryptography.Cose.CoseHeaderMap.TryGetValue
(System.Security.Cryptography.Cose.CoseHeaderLabel,System.Security.Cryptography.Cose.CoseHeaderValue@)		 Missing Missing NA Missing
M:System.Security.Cryptography.X509Certificates.CertificateRequest.CreateSigningRequestPem Present NA NA Missing
M:System.Security.Cryptography.X509Certificates.CertificateRequest.CreateSigningRequestPem
(System.Security.Cryptography.X509Certificates.X509SignatureGenerator)		 Present Present NA Missing

@ViktorHofer
Copy link
Member

@carlossanlop should we move this issue into the .NET 9 milestone? Do you know if this data is still accurate?

@carlossanlop
Copy link
Member Author

This is documentation debt - APIs that were added in .NET 7 but were not documented. I can get the latest list, maybe it's shorter.

Sure, let's move it to .NET 9.

@carlossanlop carlossanlop modified the milestones: 7.0.0, 9.0.0 Dec 6, 2023
@jeffhandley jeffhandley modified the milestones: 9.0.0, 10.0.0 Sep 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
area-Meta documentation Documentation bug or enhancement, does not impact product or test code
Projects
None yet
Milestone
10.0.0
Development

No branches or pull requests
6 participants
@krwq @jeffhandley @carlossanlop @eiriktsarpalis @ViktorHofer @tarekgh