dotnet / dotnet/docfx

Able to overwrite overload method A*

Open
#1,209 1 comment 0 reactions 0 assignees View on GitHub
authoring
Dominant language
C#
Stars
4.4k
Forks
890
Avg merge
2h 11m
Merged PRs (30d)
10

Description

Under Sandcastle, it was possible to insert documentation from an XML file about an overloaded method which applied to all overloads of that method:

```


blah blah blah .....
```

Under docfx, this does not currently seem to be supported.

Whilst the 'generic' uid of something like
```
mynamespace.myclass.myoverloadedmethod*
```
appears throughout, it does not appear that you can use it to add content with a file override. It's only appearance in the template appears to be used as an anchor point to get to the top of the list of overloads.

I previously 'fudged' its use by manually adding a child item to the yml file which I then defined and so could use a file override to insert content. This of course will get broken each time the file is re-generated, so is not a viable solution.

Unless I am totally missing something in the use of file overrides?

I don't know if this needs a code change to add an item to the yml file or if it is just a simple template change (I'm guessing the former).

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.