Re: Source code documentation



Hello,


If I do it the way you described, following exceptions occur:

An error occured while trying to build the documentation.

Exception: NDoc.Core.DocumenterException
Unable to find the HTML Help Compiler. Please verify that the HTML Help Workshop has been installed.

Exception: NDoc.Core.DocumenterException
Unable to find the HTML Help Compiler. Please verify that the HTML Help Workshop has been installed.


Exception: NDoc.Core.DocumenterException
bei NDoc.Documenter.Msdn.MsdnDocumenter.Build(Project project) in C:\Dokumente und Einstellungen\tkraus\Desktop\ndoc\src\Documenter\Msdn\MsdnDocumenter.cs:Zeile 464.

bei NDoc.Gui.BuildWorker.ThreadProc() in C:\Dokumente und Einstellungen\tkraus\Desktop\ndoc\src\Gui\BuildWorker.cs:Zeile 63.

Exception: NDoc.Core.DocumenterException
bei NDoc.Documenter.Msdn.HtmlHelp.get_HtmlHelpCompiler() in C:\Dokumente und Einstellungen\tkraus\Desktop\ndoc\src\Documenter\Msdn\HtmlHelp.cs:Zeile 188.

bei NDoc.Documenter.Msdn.HtmlHelp.CompileProject() in C:\Dokumente und Einstellungen\tkraus\Desktop\ndoc\src\Documenter\Msdn\HtmlHelp.cs:Zeile 492.

bei NDoc.Documenter.Msdn.MsdnDocumenter.Build(Project project) in C:\Dokumente und Einstellungen\tkraus\Desktop\ndoc\src\Documenter\Msdn\MsdnDocumenter.cs:Zeile 435.



Bye
Thomas


GTi schrieb:
1)
Download the source from:
http://ndoc.sourceforge.net/ndoc-nightly.zip

2)
Start MS Visual Studio 2005

3)
Open NDoc.sln and complete the Conversion Wizard

4)
Press F5 (Start debugging)

5)
Press Yes in the build error popup screen

6)
Press Add on the right side in the Ndoc application.
Locate your file(s) - for me it was a DLL file (C# .NET 2.0).

7)
Select documentation type MSDN

8)
Build documentation (Ctrl+Shift+B)

And there you a fine MSDN documentation of your source

.



Relevant Pages

  • Re: Source code documentation
    ... Exception: NDoc.Core.DocumenterException ... Unable to find the HTML Help Compiler. ... bei NDoc.Gui.BuildWorker.ThreadProcin C:\Dokumente und ...
    (microsoft.public.dotnet.languages.csharp)
  • Re: Source code documentation
    ... You need to install the html help workshop stuff. ... Exception: NDoc.Core.DocumenterException ... bei NDoc.Gui.BuildWorker.ThreadProcin C:\Dokumente und ...
    (microsoft.public.dotnet.languages.csharp)
  • Re: a criticism of java
    ... Documentation should be in English rather than java code that wasn't ... (* I personally wouldn't document all kinds of unchecked exceptions. ... Cerainly not programmer errors. ... In the rare event that the user will deal with an unchecked exception ...
    (comp.lang.java.programmer)
  • Re: jambands.com letter to the editor
    ... >>> copying, period, without permission. ... with the exception of brief excerpts in critical ... > have made a statement here that is contrary to the documentation that I have ... prohibited from making photocopies, such as the "documentation" you have ...
    (rec.music.gdead)
  • Re: Problems Handling Errors Correctly
    ... remember the web site off hand but Google "SandCastle help generator" and you'll find a utility that turns the xml file generated from the code comments into MSDN style documentation ... Every once in a while you'll get an exception that's thrown from deep in the stack that doesn't seem intuitve, but for me it's usually when I'm dealing with remoting or xml stuff. ...
    (microsoft.public.dotnet.languages.csharp)

Quantcast