This project has moved and is read-only. For the latest updates, please go here.

Missing <summary> in documentation

Topics: Developer Forum, User Forum
Apr 17, 2008 at 2:24 PM
Edited Apr 17, 2008 at 2:26 PM

In my code i got xml comments with summary.

''' <summary>
''' Sets pagetitle on page
''' </summary>
''' <value>Page title</value>
''' <returns>string page title</returns>
''' <remarks></remarks>
Public Property PageTitle() As String
Return m_PageTitle
End Get
Set(ByVal value As String)
m_PageTitle = value
End Set
End Property

But then when i look in documentation there are no summary on methods and properties...
(Missing documentation for P:Company.BasePages.BasePage.PageTitle)

  • I use latest january 2008 sandcastle build with Sandcastle Help File Builder.
  • VB.NET
  • .NET Framework 3.0
  • SandCastle Help File Builder as GUI
  • Run documentation on debug code..
  • Visual Studio 2008

Anyone else having problems with summary not shown in documentation?
Apr 17, 2008 at 3:59 PM
Do you see the comments in the actual XML comments file? It could be you just need to rebuild the project to include the comments. You might also check the help project to make sure it is using the correct copy of the XML comments file (i.e. Debug instead of Release).

Apr 17, 2008 at 5:14 PM
Thank you Eric, you guided me right there with xml comments file... :)

I tried another documentation tool that created a xml file in root of project that did not include summary... as default i guess SandCastle search for a file with same name as assembly.... so in this case it took wrong xml file....

Maybe something to change...that first place SandCastle would search for xml comment file would be either debug or release folder....

Now it works fine :)