OS dependent based API documentation should be marked. about website HOT 1 OPEN

Answering the question from @RLittlesII over in Wyam:

In ReactiveUI we have several API's that are specific to certain platforms. Does Wyam provide a way when generating the API documentation to categorize the API's to relevancy?

Example would be certain API's are relevant only in iOS or Android.

Not out of the box, no. That's a tough thing to get right because to Wyam, code is code is code. If Roslyn builds it and it ends up in the API docs, it's all the same. We'd need some way to say "this is iOS only" or "this is for all platforms".

Just quickly brainstorming, this might be doable with custom XML doc comments. Since those are picked up and exposed in the Wyam IDocument for each symbol, you could override the _ApiBeforeContent.cshtml file to show some sort of disclaimer depending on if the given XML doc comment is present on the symbol. For example, Cake overrides this file to show a disclaimer about being third-party here which displays this partial.

And actually, another way to do it would be to do something even more like what Cake is doing. Override the _ApiBeforeContent.cshtml file to check the symbol's namespace or assembly. If it matches one that's known to be just for a particular platform, display the appropriate disclaimer.

cc @ghuntley @onovotny

from website.