Document argument attributes?

Topics: User Forum
Oct 5, 2012 at 7:22 PM

Is there a way to document attributes applied to method arguments? (I know about DocumentAttributes project setting - but that one seems to apply to attributes on types and members only).

Specifically, I have many method arguments marked up with ReSharper-s [CanBeNull] and [NotNull], and it would be extremely useful to the user of my API to see those.

Thanks

Coordinator
Oct 5, 2012 at 8:19 PM
Edited Oct 5, 2012 at 8:20 PM

It isn't currently possible as the MRefBuilder tool doesn't output attribute information other than some common information such as whether it's an output parameter, reference parameter, or optional parameter.  The information is probably there so it could be included if so.  In addition, all of the syntax generator build components would need to be updated to output the information as well.  You can open a workitem if you like at the Sandcastle project for further investigation and inclusion in a future release.

Eric