By using this site, you agree to our updated Privacy Policy and our Terms of Use. Manage your Cookies Settings.
435,009 Members | 2,859 Online
Bytes IT Community
+ Ask a Question
Need help? Post your question and get tips & solutions from a community of 435,009 IT Pros & Developers. It's quick & easy.

Doc Project help

P: n/a
I'm creating a doc project for my c# program. I've done this before but this
time sonething is wrong. I build my doc project and is succeeds but when I
open the help file, there is no documentation there. I enabled XML
documentation file under build properties and have recompiled my program but
still I have nothing. What am I doing wrong?
--
-ScottRadDev
Aug 22 '08 #1
Share this Question
Share on Google+
2 Replies


P: n/a
On Aug 22, 5:53*am, ScottRadDev <ScottRad...@nospam.nospamwrote:
I'm creating a doc project for my c# program. I've done this before but this
time sonething is wrong. I build my doc project and is succeeds but when I
open the help file, there is no documentation there. I enabled XML
documentation file under build properties and have recompiled my program but
still I have nothing. What am I doing wrong?
--
* * *-ScottRadDev
Sorry, what program are you using to create the documentation?
Some programs have bugs so they don't work.
You also must enable the XML documentation file under build properties
in VS and then specify the location of that XML file in the
documentation program.

I recommend using NDoc. It creates high quality, nice looking
documentation, with lots of different available styles.
For .NET 2.0 assemblies, you'll need an unofficial version, which you
can get at: http://www.kynosarges.de/NDoc.html
Unfortunately, when using NDoc, you have to edit the NDoc.js file a
tiny bit after it's created so that it can be viewed in Firefox, but
it's not too much of a hassle. At least it's free!

Please post what program you're using, so we'll be able to help you
more.
Aug 23 '08 #2

P: n/a
Hello ScootRadDev,

Welcome Microsoft Newsgroup Support Service! My name is Hongye Sun [MSFT].
It's my pleasure to work with your on this issue.

Based on my understanding of your issue, I know that you are trying to use
an documentation project to build a help file by reading information from
xml documentation file generated by VS.net. I know it is strange that the
doc project was once working well but failed this time without any error.
Is it possible for you to help us to collect some information that will
narrow down the problem.

1. Is the xml documentation file generated correctly? You can open file in
the path which you specified in the project properties/build tab. And check
if the XML file contains all the documentation comments in your code.
2. If the xml documentation is empty or obviously not correct, could you
please send me the source code of your C# program via email? My email is
ho*****@microsoft.com.
For the detail of programming guide of XML documentation comments, please
refer to http://msdn.microsoft.com/en-us/libr...f7(VS.80).aspx.

If the xml documentation file is correct, please check:
3. Is the doc project a third party software, like NDOC? And what is it?
4. If yes, is there any error or build log generated by third party
software? For example: NDoc's build log is located in the doc folder under
its execution path. Please send it to me.
5. If the xml doc is correct, and there is no error generated by third
party software, and there is still no documentation in help file. Possibly,
it is caused by third party software bug or incorrect configuration or
usage. You can connect to the third party website and community to see if
they can help you on that.

I will wait for your further information. Thanks.

Regards,
Hongye Sun (ho*****@online.microsoft.com, remove 'online.')
Microsoft Online Community Support

Delighting our customers is our #1 priority. We welcome your comments and
suggestions about how we can improve the support we provide to you. Please
feel free to let my manager know what you think of the level of service
provided. You can send feedback directly to my manager at:
ms****@microsoft.com.

==================================================
Get notification to my posts through email? Please refer to
http://msdn.microsoft.com/en-us/subs...#notifications.

Note: The MSDN Managed Newsgroup support offering is for non-urgent issues
where an initial response from the community or a Microsoft Support
Engineer within 1 business day is acceptable. Please note that each follow
up response may take approximately 2 business days as the support
professional working with you may need further investigation to reach the
most efficient resolution. The offering is not appropriate for situations
that require urgent, real-time or phone-based interactions or complex
project analysis and dump analysis issues. Issues of this nature are best
handled working with a dedicated Microsoft Support Engineer by contacting
Microsoft Customer Support Services (CSS) at
http://support.microsoft.com/select/...tance&ln=en-us.
==================================================
This posting is provided "AS IS" with no warranties, and confers no rights.

Aug 25 '08 #3

This discussion thread is closed

Replies have been disabled for this discussion.