This project has moved. For the latest updates, please go here.

Document attributes of classes/methods et cetera?

Topics: User Forum
Jul 26, 2012 at 1:31 PM

Is there a way to document attributes that have been applied to the documented code, and if so, can the properties of these attributes be documented automatically?

Specifically I'm using a class deriving from PrincipalPermissionAttributes and would like to document what roles are requested.

I know there is a <permisison> Xml doc comment, but I would like to rule out human error of documenting this manually, and also document attributes that have been applied using multicasting. (for instance using Postsharp)

Jul 26, 2012 at 4:50 PM

Enable the DocumentAttributes project property.  It's false by default and will remove all but a few important attributes such as Obsolete, Flags, Serializable, and a few others.  When true, all other attributes will be included as well with the exception of interal and compiler related ones filtered out by the MRefBuilder configuration file.  Property values passed to the attributes will be included in the Syntax section of the topic.



Jul 31, 2012 at 5:47 PM

Thanks for the reply, I'm rebuilding now an curious about the results.