Default arguments to methods not indicated

Jun 27, 2012 at 5:38 PM


I was taking a closer look at my Sandcastle-built documentation file and I noticed (for the first time) that methods which have default - and hence optional - arguments are not shown in the documentation as such. In other words, all the method arguments are listed the same way whether they are mandatory or optional. As a result, someone viewing the documentation would have no way of knowing if the argment list contains optional arguments (aside from being given this information in the comments section).  Have I missed a setting somewhere?



Jun 27, 2012 at 7:30 PM

The latest release (Sandcastle v2.7.0.0 or SHFB v1.9.4.0) adds support for showing the optional argument values in the syntax section for class members.