Menu

XML comments not being used

Help
2010-09-21
2013-04-25
  • Ross Presser

    Ross Presser - 2010-09-21

    Using VS.NET 2008 with a VB.NET class library project (.NET 3.5). XML comments file exists and has plenty of comments, which I see scrolling by in the output window. For example, this is in the output window:

    TRACE: processing comment '[
    PlatformASMX
    ]M:PlatformASMX.Workflows.MoveOrderItemToWorkflowStage(ORMLayer.OrderItem,System.String,System.String)':
    <summary>
    Move an order item to a new stage
    </summary>
    <param name="anOrderItem">order item to be moved</param>
    <param name="printerStage">printer name for stage it is moving to</param>
    <returns>0 if moving failed. -1 if the move was to a previous stage according to the assigned workflow. +1 if it was to a later stage.</returns>
    <remarks></remarks>

    Generated documentation includes NO comments. What am I doing wrong?

     
  • Ross Presser

    Ross Presser - 2010-09-21

    I ran my XML docs through tidy - which found no errors, just provided indentation - before running NDoc3, and now my comments show up in the CHM file.

     
  • Xharze

    Xharze - 2010-09-22

    Do you by any chance have a copy of the "old" XML file you could upload?

     
  • Ross Presser

    Ross Presser - 2010-10-01

    Sure … it comes back every time I build the project. I have to run through tidy before running NDoc3.  Where should I upload it to?

     
  • Ross Presser

    Ross Presser - 2010-10-01

    OK, I uploaded it as an attachment to a support request in the tracker.

     
  • Nobody/Anonymous

    Was this ever resolved?  I also have the same issue and have not been able to download tidy from sourceforge…  I would really like to see this bug fixed.

     

Log in to post a comment.