Why SHFB displays '[Missing <param name=.."/>' in red when the XML documentatiin is there?

Topics: User Forum
Apr 3, 2013 at 8:32 AM
Why SHFB displays '[Missing <param name=.."/>' in red when the documentatiin is there? For example, for the nopCommerce project, it's showing a lot of [ missing..' For example the method, Nop.Data.IDbContext.ExecuteSqlCommand, there's XML documentation in the source.
Coordinator
Apr 3, 2013 at 8:23 PM
Edited Apr 3, 2013 at 8:24 PM
First and foremost, the project in question must be configured to produce an XML comments file and you must have included it in the SHFB project as a documentation source either directly by name or indirectly through using the project that creates it as a documentation source. If you aren't seeing any comments, that's the most likely issue. If only certain things are missing, the most common cause is that the XML comments file is out of date. The build log will tell you which XML comments files were included. If they aren't the ones you expected (i.e. Debug vs. Release), you can change the platform and configuration options to build with the correct ones. You can also look at the files to see if the member comments are actually in the file and that it is up to date.

Eric