This project has moved. For the latest updates, please go here.

DocumentInternals-problem with VB forms

Topics: Developer Forum, User Forum
Feb 25, 2009 at 2:25 PM
When using the SHFB's DocumentInternal=True option with a VB Windows Forms project, I have a problem documenting the controls on a form.
I added <subject> and <remark> comments in the forms .Designer.vb file, right above the e.g. Friend WithEvents Button1 As System.Windows.Forms.Button-statement.
Both comments are part of the XML file, but in the help file build by SHFB Gui these are missing.

I checked the XML file and noted that the syntax there is e.g. <member name="F:SHFB_test.Form1.Button1">...</member>
If I change that to <member name="P:SHFB... (from field member to property), SHFB uses the data correctly and the comments appear in the help file.

Do I document at the wrong place in my project? Is it a VB compiler problem? Or an SHFB issue?
How can I circumvent thsi problem without manually replacing all applicable F's by P's?

TIA Valkon

Feb 25, 2009 at 3:15 PM
It's a known issue with the VB.NET compiler.  It does some stuff behind the scenes.  See this thread: