473,224 Members | 1,368 Online
Bytes | Software Development & Data Engineering Community
Post Job

Home Posts Topics Members FAQ

Join Bytes to post your question to a community of 473,224 software developers and data experts.

Doc Project help

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
2 1506
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
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 thread has been closed and replies have been disabled. Please start a new discussion.

Similar topics

1
by: Edward Stevens | last post by:
The IDE Start Page in .Net 2003 contains a list of the projects you have recently worked on. Clicking on any of these opens that particular project. Fine. Unfortunately, one of my projects has...
5
by: David Webb | last post by:
The problem started when the Working Folder for a project was somehow set to the folder of another project. I set the correct working folder in VSS and deleted the .vbproj files that had been...
10
by: TokiDoki | last post by:
Hello there, I have been programming python for a little while, now. But as I am beginning to do more complex stuff, I am running into small organization problems. It is possible that what I...
2
by: genc_ymeri | last post by:
Hi, We are a team of 4 using win2003 server (sp1) in our dev machines and VS2003 for our .Net web app. We did make a copy of our project (located to one "hardwarely old" PC ) to our machines. All...
1
by: Vladimír Kolesnik | last post by:
Hi, there we need help concerning setting project under source control. We want to have a project on the server, and developers in the local network working on this project. We decided to use...
3
by: alan_coffman2004 | last post by:
Opening an ASP.NET VS2002 project in VS2003, am getting this error: "Unable to open Web project 'MyProject'. The file path 'c:\inetpub\wwwroot\MyProject' does not correspond to the URL...
3
by: Jerad Rose | last post by:
This is regarding Visual Studio 2003 (framework 1.1). We have several projects/libraries. Of course, many of these reference each other. If we only had one solution, we would simply add all of...
4
by: NareshKumar | last post by:
Hi all, I'm using existing ASP.net project to make some enhancements which is secured by Visual source safe and in my system frontpage is installed. Now when i run the project file i get...
24
by: =?Utf-8?B?RHIuIFMu?= | last post by:
I am incorporating three existing programs into a new "all in one" program. I have added the three projects to the new all in one project. How do I instruct the new initial menu to launch the main...
4
by: Alan Mailer | last post by:
Again, I'm new to VB.net and there is something I need help with: Like (I assume) many of us, over time I want to be able to create some VB.net classes that I might want to use in more than one...
0
by: veera ravala | last post by:
ServiceNow is a powerful cloud-based platform that offers a wide range of services to help organizations manage their workflows, operations, and IT services more efficiently. At its core, ServiceNow...
0
by: jianzs | last post by:
Introduction Cloud-native applications are conventionally identified as those designed and nurtured on cloud infrastructure. Such applications, rooted in cloud technologies, skillfully benefit from...
0
by: mar23 | last post by:
Here's the situation. I have a form called frmDiceInventory with subform called subfrmDice. The subform's control source is linked to a query called qryDiceInventory. I've been trying to pick up the...
2
by: jimatqsi | last post by:
The boss wants the word "CONFIDENTIAL" overlaying certain reports. He wants it large, slanted across the page, on every page, very light gray, outlined letters, not block letters. I thought Word Art...
2
isladogs
by: isladogs | last post by:
The next Access Europe meeting will be on Wednesday 7 Feb 2024 starting at 18:00 UK time (6PM UTC) and finishing at about 19:30 (7.30PM). In this month's session, the creator of the excellent VBE...
0
by: fareedcanada | last post by:
Hello I am trying to split number on their count. suppose i have 121314151617 (12cnt) then number should be split like 12,13,14,15,16,17 and if 11314151617 (11cnt) then should be split like...
0
by: stefan129 | last post by:
Hey forum members, I'm exploring options for SSL certificates for multiple domains. Has anyone had experience with multi-domain SSL certificates? Any recommendations on reliable providers or specific...
0
Git
by: egorbl4 | last post by:
Скачал я git, хотел начать настройку, а там вылезло вот это Что это? Что мне с этим делать? ...
1
by: davi5007 | last post by:
Hi, Basically, I am trying to automate a field named TraceabilityNo into a web page from an access form. I've got the serial held in the variable strSearchString. How can I get this into the...

By using Bytes.com and it's services, you agree to our Privacy Policy and Terms of Use.

To disable or enable advertisements and analytics tracking please visit the manage ads & tracking page.