api-doc-tools icon indicating copy to clipboard operation
api-doc-tools copied to clipboard

.NET Reference API Toolchain

Results 100 api-doc-tools issues
Sort by recently updated
recently updated
newest added

See more details in dotnet/docs#5208 There are couple important points here: - For types (like `Span`) that are `ref struct` types, the `ref` modifier is missing. - When a method...

enhancement
help wanted

Take `M:System.Data.SqlClient.SqlDataReader.GetColumnSchema` for example, you can see in its [ECMAXML file](https://github.com/dotnet/dotnet-api-docs/blob/master/xml/System.Data.SqlClient/SqlDataReader.xml#L606), there's a assembly info tag that does not have any versions at all: ```xml System.Data ```

bug

For example: https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.VisualBasic/Collection.xml#L798 Seems to be happening for EIIs.

bug

This time it's when type parameter names are different in generic methods, like: ```xml Method System.Data.Linq 4.0.0.0 S To be added. To be added. To be added. To be added....

enhancement

This was previously reported at https://github.com/aspnet/EntityFramework.ApiDocs/issues/25, specifically for methods that contain cancelationToken = default, which is a really common pattern,but it could apply to other defaults, not sure. From the...

enhancement
lang-csharp

When using xml files from [this folder](https://apidrop.visualstudio.com/_git/XMLDevDrop?path=%2Ffeb-24-2017&version=GBmaster&_a=contents) , I found 9 files has empty param names in their `` node, like this one from ``Microsoft.VisualC.StlClr.Generic\ReverseRandomAccessIterator`1.xml`` ```xml To be added. To...

enhancement

It would be nice to be able to round-trip API docs through `mdoc` in order to standardize white space, attributes, and so on. For example: `mdoc --canonicalize ./Application.xml` would result...

enhancement
help wanted
good first issue

For example, according to [This ECMAXML](https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.JScript/IEngine2.xml#L40), `M:Microsoft.JScript.IEngine2.Clone(System.AppDomain)` is only in Microsoft.Jscript 10.0.0.0. However if you search in FrameworkIndex file, you can find this doc id in every .NET Framework version...

bug

This is an example of a method with a vararg param: https://docs.microsoft.com/en-us/dotnet/api/system.console.write?view=netframework-4.8#System_Console_Write_System_String_System_Object_System_Object_System_Object_System_Object_ I don't know how many we had of these. On [MSDN](https://msdn-pre-redirect.redmond.corp.microsoft.com/en-us/library/0dhytxs1), a ... param was added to the...

enhancement
help wanted

Currently, only the `Source` attribute is being used to name the `FrameworksIndex/*.xml` file, and in the resulting `` element. These values should be sourced from the `Name` attribute instead. _edit:_...

bug
help wanted
good first issue