Skip to main content
Home Forums General Silverlight Getting Started How to create a help documentation
6 replies. Latest Post by rishu on July 3, 2009.
(0)
rishu
Member
14 points
55 Posts
06-26-2009 1:52 AM |
Hi ,
I have created a silverlight library project ,having some custom controls. Now I want to create a documentation for this. Something similar to silverlight help files / chm files. Can you tell me if there is any support from visual studio to create it . Or if is there any tool to use for this.
This is first time I am going to create such documentation so it would be helpful for me if you can tell me that what are the best ways to do it?
Thanks and Regards,
Rishu
TomBeeby
Participant
1151 points
188 Posts
06-26-2009 2:29 AM |
My team uses DocProject for sandcastle
What you do is this: embed the documentation as comments in your code and let visual studio automatically generate an XML for you. Docproject takes that XML file and uses sandcastle to build it into a nice CHM you can deploy.
DocProject builds the CHM files for you and provides an interface for creating conceptual topics
Dave Sexton - the owner of this project - has done a really good job with the tool and the doucmentation. highly recommended.
http://www.codeplex.com/DocProject
06-26-2009 4:58 AM |
Hi Tom,
Thanks you very much for your help. It helped. this is excatly what I need....
Regards,
07-03-2009 12:34 AM |
Hi Tom, I installedDocproject and tried to use it . But I am getting an error when trying to buid the DocProject: The error says: Error 1 The "C:\Program Files\Sandcastle\ProductionTools\MRefBuilder" process failed with exit code: 1. following are the things which I did. : 1. I added a new project of type DocProject to the existing silverlight solution in visual studio 2008 sp1 2. In the wizard I refered to one project of the type "silverlight Application library". 3. I tried to build the Doc Project but got the above mentioed error. Could any one help me by telling how can I get the more details about the error and resolve it. Same steps when I tried with a c# project , it worked fine. Is there any issue with the silverlight project? did you face such problem ? Thanks and Regards, rishu
I installedDocproject and tried to use it . But I am getting an error when trying to buid the DocProject: The error says:
Error 1 The "C:\Program Files\Sandcastle\ProductionTools\MRefBuilder" process failed with exit code: 1.
following are the things which I did. :
1. I added a new project of type DocProject to the existing silverlight solution in visual studio 2008 sp1
2. In the wizard I refered to one project of the type "silverlight Application library".
3. I tried to build the Doc Project but got the above mentioed error.
Could any one help me by telling how can I get the more details about the error and resolve it.
Same steps when I tried with a c# project , it worked fine. Is there any issue with the silverlight project?
did you face such problem ?
07-03-2009 12:35 AM |
07-03-2009 12:54 AM |
you need to include some "Missing Dependencies"
open up the DocProject UI by right clicking on the project and select 'DocProject Properties'.. look for the Missing Dependencies option and put in the Silverlight SDK directory, eg:
C:\Program Files (x86)\Microsoft SDKs\Silverlight\v2.0\Reference Assemblies\
that should fix it i would think
07-03-2009 2:21 AM |
It worked!!!!!!!!!!!
Thanks a lot for your help.
How to create a help documentation