website icon indicating copy to clipboard operation
website copied to clipboard
verified publisher icon cake-build

Display operator overloads in docs

Open daveaglick opened this issue 8 years ago • 3 comments

Being tracked in https://github.com/statiqdev/Statiq.Web/issues/468

daveaglick avatar Mar 10 '17 15:03 daveaglick

This is now implemented in Wyam and will go out with the next release. Let's leave this issue open until we verify it works for the Cake docs in production after the Wyam release.

daveaglick avatar Mar 10 '17 23:03 daveaglick

@daveaglick nice!

gep13 avatar Mar 11 '17 17:03 gep13

@daveaglick I checked for ConvertableDirectoryPath which has for example an operator overload for +:

https://github.com/cake-build/cake/blob/develop/src/Cake.Common/IO/Paths/ConvertableDirectoryPath.cs#L89-L96

While operator overloads seem to appear in the API documentation, the summary from XML comment from source code doesn't seem to be used:

https://cakebuild.net/api/Cake.Common.IO.Paths/ConvertableDirectoryPath/#Operators

pascalberger avatar Oct 07 '20 19:10 pascalberger