Link to home
Start Free TrialLog in
Avatar of AWestEng
AWestEngFlag for Sweden

asked on

Generate help documents from XML VS 2005

Hi!

I like to generate a help documnet from the XML code that I have in my code.

Like the VBCommenter
http://msdn.microsoft.com/en-us/library/aa289191(VS.71).aspx
SOLUTION
Avatar of Dirk Haest
Dirk Haest
Flag of Belgium image

Link to home
membership
This solution is only available to members.
To access this solution, you must be a member of Experts Exchange.
Start Free Trial
Avatar of AWestEng

ASKER

generate help documents fron the XML comments that I have for each sub/function etc
If I try to downlaod I'll get this

This project is not yet published

If you are a coordinator or developer on this project, please sign in to access the project.
ASKER CERTIFIED SOLUTION
Link to home
membership
This solution is only available to members.
To access this solution, you must be a member of Experts Exchange.
Start Free Trial
Ok.. So I have installed the sandcatle

I'm trying to understand this part.

Build > Help File Format: Enable HtmlHelp2x
Build > Dependencies: Add all assemblies your assembly depends on here.
Build > Framework Version: Select the .NET Framework version your assembly is build on.
Help File > Presentation Style: Select vs2005. This is not neccessary but pretty.
Paths > HtmlHelp2xCompilerPath: Give the path to the directory where hxcomp.exe is located.
Paths > SandcastpePath: Set it to the correct installed sandcastle path. In my case I had multiple versions
of sandcastle installed and had to specify where the newest version is installed.


but I can't find these settings?
Probably is the version changed ...
I'll check it !

Perhaps this link can help you
https://blogs.msdn.com/sandcastle/archive/2006/07/29/682398.aspx
hmm. I new to this so I'm not sure how to do it in VS 2005

I  don't understand the text in the url

sorry for all the questions..

that one is only for vs 2003
SOLUTION
Link to home
membership
This solution is only available to members.
To access this solution, you must be a member of Experts Exchange.
Start Free Trial
oki. so this is not the sandcastle , this is something else?
Actually it's almost the way I do it. I let my visual studio generate an xml-document and with ndoc I create a chm, xml, ... depending of my needs. Usually I use it to document my project
oki.
When I installed the SDK for Vs 2005 I got HelpStudio from http://www.innovasys.com/

Is this something you know about?
I don't know, so I can't tell anything about it.
okit thx anyway..

If I chech the nDoc url I can see theis code snippet

<system.codedom>
<compilers>
<compiler language="vb;vbs;visualbasic;_vbscript" extension=".vb" type="Microsoft.VisualBasic.VBCodeProvider, System, Version=1.0.5000.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" compilerOptions="/doc+ /optionstrict+"/>
</compilers>
</system.codedom>

But that is for ASP how shuld it look in VB
Now DONOT try to run the NDoc Application by clicking F5. I did that initially and I had a solution that had around 5-6 projects. It was failing giving an error: Falied to load Assembly&blah..blah..

So the solution is to run the NDocGui.exe from NDoc2005\src\Gui\bin\Debug path.

Now before starting the generation, you need to enable the XML document generation for each project in VS 2005(Project Properties->Build->Output->XMlDocumentationFile)

Now add the decoration for you class and methods.
I found some good article on this at:
http://www.codeproject.com/csharp/csharpcommentinganddocs.asp
which could be a good starting point.

Now run the NDocGui.exe and specify ur solution name. It took a good amount of time to convert, but it is really fantastic.

You get the MSDN style documentation, very neat and clean.

Thanks a lot to NDoc..!!
Oki..

I have donloaded the ndoc .
When I run nDoc there is a GUI that is opend.
What do I do now?

Can i implement the nDoc in VS like a add-in or something or must I always run the nDoc as a separately project ad create the help doc from that?
and when trying to import the solution into the nDoc I got this

"There are no projects in this solution that NDoc can import.

Either the solution is blank, or the projects contained within
the solution are not of a type NDoc can import."
>> Can i implement the nDoc in VS like a add-in or something or must I always run the nDoc as a separately project ad create the help doc from that?

It's always a separate project.
Now run the NDocGui.exe and specify ur solution name (through the add-button).
Next is to generate the help (fifth icon or ctrl-shift-B)
It took a good amount of time to convert, but it is really fantastic.
oki I got it to work now. thx alot.. :)
Glad I could help you.