I have been searching for documentation on how to interpret the Sand Castled documentation compilation and build log file but I couldn't find any.
For instance I have a few lines of warning from my compilation log, what does the prefix M, T, P, N and F alphabets means ?
Is there any other alphabets besides the ones that I have mentioned and what do they mean.
Warn: ShowMissingComponent: [__M__:...] Missing <summary> documentation
Warn: ShowMissingComponent: [__T__:...] Missing <summary> documentation
Warn: ShowMissingComponent: [__P__:...] Missing <summary> documentation
Warn: ShowMissingComponent: [__N__:...] Missing <summary> documentation
Warn: ShowMissingComponent: [__F__:...] Missing <summary> documentation
I am trying to do a count on what documentation is missing from my codes, but I notice the <summary> tag can be used for class level documentation as well as method level, so a missing <summary> warning dosent tell me at which level the documentation
I have written a script to parse through the Sand Castle compilation log that churns out the numbers of missing documentation
The summary tag missing documentation come up to a total of 13k missing documentation but I need a further break down of what type of summary is not documented. That is the reason why I need to know what is the meaning of the alphabet prefix in the sand castle
Remarks Documentation 26,765
Returns Documentation 2,698
Typeparam Documentation 58
Summary Documentation 13,584
Value Documentation 15,787
Param Documentation 4,422
Total Missing 63,314
I have searched all over the sand castle documentation I couldnt find a section that teaches me how to interpret the log files.