Missing <summary> documentation

Topics: Developer Forum
Dec 4, 2007 at 12:45 AM
Ok, I'm getting closer with this! Using VBCommenter, I have VB.Net 2003 generating cool little XML files. I have Sandcastle Help File Builder all set up and generating a nice help document. But Sandcastle is not picking up the XML comments I have entered.

Here is a portion of the generated XML file:

- <member name="F:LMSNET.sutAdmin.Ad">
- <member name="F:LMSNET.sutAdmin.Ad">
- <member name="F:LMSNET.sutAdmin.If">
- <member name="M:LMSNET.sutAdmin.GetStartDateTime">
<summary>Test VBCommenter - GetStartDateTime</summary>
<returns>Returns a DateTime.</returns>
<remarks>Testing remarks.</remarks>
<history>nk 12/3/2007 Created</history>
</member>
- <member name="M:LMSNET.sutAdmin.GetEndDateTime">
<summary>Test VBCommenter - GetEndDateTime</summary>
<returns>Returns a DateTime.</returns>
<remarks>Testing remarks.</remarks>
<history>nk 12/3/2007 Created</history>
</member>
</member>
</member>
</member>

Here is a what the generated Help file says:

Missing <summary> documentation for M:LMSNET.sutAdmin.GetStartDateTime
Missing <returns> documentation for M:LMSNET.sutAdmin.GetStartDateTime

Any clue as to what I am missing or doing incorrectly? Thanks!
Coordinator
Dec 4, 2007 at 2:31 AM
If the stuff you posted is what's in the XML comments file, then VBCommenter isn't outputting the file correctly. The <member> elements should not be nested within one another. Each should be a separate element within the <members> element. Nested as they are in your example, it won't find anything put the first one.

Eric