Hi @LL, hope somebody might be able to help me out on this. I'm using the XML comment tags like <summary> etc. to comment my (C#) source code. To generate documentation I currently use NDoc. Now, the thing I am trying to do is adding line breaks in the XML comment to format the resulting output in the documentation. It should be something like this: /// <summary> /// Some explanation ... <br/> /// <br/> /// Some more info ... <br/> /// <br/> /// And even more ... <br/> /// <br/> /// Developer info ... /// </summary> Which should produce output in the NDoc generated helpfile that actually looks like intended: Some explanation ...<line break> <line break> Some more info ...<line break> <line break> And even more ...<line break> <line break> Developer info ... But it does not work. NDoc seems to ignore the break commands I use (I tried the HTML <br/> and \n) completely. Questions are this: - Do I use the wrong command to manually add a line break to the output ? - Is it possible at all ? - Might it be an NDoc "problem" ? Thanks for any suggestions.
I would use <para> tag. It has the same purpose as <p> in HTML. It's recommended by MS (http://msdn.microsoft.com/library/default.asp?url=/library/en-us/csref/html/vclrfpara.asp) and Ndoc should support it. If you are on VB .NET boat, you can use our WYSIWYG comment editor which automatically formats <para> sections. -- Peter Macej Helixoft - http://www.vbdocman.com VBdocman - Automatic generator of technical documentation for VB, VB ..NET and ASP .NET code
Thanks for the tip. Unfortunately, it didn't work out with NDoc. I even tried it with the lastest NDoc build but still not the expected results. After digging deeper into that problem at the various NDoc help sources I guess it should work that way with NDoc too, but it simply does not for me.
It seems that I only a some problems with my configuration. Now the <para> tags are written correctly to the XML file and NDoc can work with them. Thanks for the hint again. Problem solved.
So, are you able to get line breaks recognized in your NDoc compiled help file? I am having similar problems; however, the <para> tag is actually included as text in the compiled help file. I also tried <br> and <p> and these are also included as text in the help file. NDoc compiles fine; the problem is that it includes the line break tags as text in the help file and no line breaks are displayed. If anyone has any ideas please let me know. Thanks, Curtis 2biased wrote: > It seems that I only a some problems with my configuration. Now the > <para> tags are written correctly to the XML file and NDoc can work > with them. > > Thanks for the hint again. Problem solved.
