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

Support specific build configurations for metadata #1518

Closed
jskeet opened this issue Apr 3, 2017 · 2 comments
Closed

Support specific build configurations for metadata #1518

jskeet opened this issue Apr 3, 2017 · 2 comments
Assignees

Comments

@jskeet
Copy link

jskeet commented Apr 3, 2017

As far as I can tell, the docfx metadata command configuration doesn't specify which project configuration or target framework to extract metadata for. In Noda Time we have some members which are present in one build but not another, and I'd really like to make this clear in the documentation... is there any way to either tell docfx which project configuration / tfm to build, or at least specify C# preprocessor symbols to define?

@MichaCo
Copy link

MichaCo commented Apr 5, 2017

Not sure if that's the same request @jskeet but I'd also love to see some indication in the docs of e.g. classes, for which target frameworks the code is available/visible..

At least IF you have multitarget projects, like NET40, NET45, netstandard14... and you ifdef parts of the code away, it would make sense to indicate that.

Advanced version could be something like the version switch at the top of the screen (MSDN docs).
The minimal solution could be an additional field near namespace and assembly? like:

Namespace:MyNameSapce
Assembly:Awesome.dll
Target:.NET45, .netstandard1.3

@jskeet
Copy link
Author

jskeet commented Apr 5, 2017

@MichaCo: Yes, that's basically what I was intending to achieve, but I'd expected to have to do that with my own tooling, based on the results of running docfx twice. If docfx could do it itself, that would be even better :)

(I have something similar for which version a member was introduced in - see http://nodatime.org/2.0.x/api/NodaTime.Duration.html for example, and look at the "Since" point in each member.)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants