Skip to content

API documentation debt - System.Formats.Cbor #43858

@carlossanlop

Description

@carlossanlop

Area owners: @eiriktsarpalis

The CborContentException type was accidentally missed it in the 5.0 effort. 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.

System.Formats.Cbor
DocId Summary Parameters TypeParameters ReturnValue
M:System.Formats.Cbor.CborContentException.#ctor(System.String,System.Exception) Missing Missing NA NA
M:System.Formats.Cbor.CborContentException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext) Missing Missing NA NA
M:System.Formats.Cbor.CborContentException.#ctor(System.String) Missing Missing NA NA
T:System.Formats.Cbor.CborContentException Missing NA NA NA

The System.Formats.Cbor namespace is also missing a summary. We don't have an equivalent file in the runtime repo where this can be documented, so please add the text directly in dotnet-api-docs:
https://github.com/dotnet/dotnet-api-docs/blob/c9445d2d3a5711aea5998fde980110c14bcc1075/xml/ns-System.Formats.Cbor.xml#L3

Metadata

Metadata

Labels

area-System.Formats.CbordocumentationDocumentation bug or enhancement, does not impact product or test codehelp wanted[up-for-grabs] Good issue for external contributors

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions