Missing Docs

Topics: User Forum
Oct 29, 2007 at 12:50 AM
Is it possible to dump the "missing" stuff somewhere for correction?
Normally, you will wish to fix those "missing" docs but browsing each item
to find the missing parts is difficult.

If the SHFB component that documents the "missing" can also be configured
to log that in a separate file, it will be very useful.

Best regards,
Paul.
Coordinator
Oct 29, 2007 at 4:46 AM
Edited Oct 29, 2007 at 5:14 AM
The missing items are noted in the log file so you can search it for any line prefixed with "Warn: ShowMissingComponent:" for a summary of the missing stuff. I've also written an IntelliSense build component. It'll be in the next release but likely won't appear in the configuration files by default. The new component will dump all XML comments to an XML comments file in the output folder. Only the comments necessary to use IntelliSense will be present for only the documented APIs. That will include the "missing" comments if the ShowMissing* properties are used. Searching that output should make them easier to find too. It'll be easy enough to add in the configuration to use it for the time being. I'm working on a new method of supporting the custom build components which will make it easier to use them without having to modify the template configuration files and so that I don't have to add properties for them to the project file itself.

Eric