ndoc-users

[Ndoc-users] FW: Setting XML documentation for website assembly

[Greg Q. <Gre...@de...>]

Sorry, only subscribed now after sending this message.

Please resend your message if you already replied.

=20

Thanks

=20

________________________________

From: Greg Quinn=20
Sent: 17 April 2007 02:14 PM
To: 'ndo...@li...'
Subject: Setting XML documentation for website assembly

=20

Hi,

=20

I am using Visual Studio 2005 and Ndoc 2.0.0.0

I have a webservice I have compiled into an assembly.

=20

However in the generated documentation, none of the methods, even though
all with correct summary tags, have a description.

I believe this problem to be in that the website is not generating the
XML documentation file necessary for NDoc.

=20

Now the question, where do I set the option in Visual Studio 2005 for
the website/webservice to generate the XML documentation? I can see this
option for normal Windows apps. But not for a website.

=20

Thanks

=20


#########################################################################=
####################
The information transmitted is intended only for the person or entity to =
which it=20
is addressed and may contain confidential and/or privileged material.=20
Any review, retransmission, dissemination or other use of, or taking of a=
ny action
in reliance upon, this information by persons or entities other than the =
intended=20
recipient is prohibited. If you received this in error, please contact th=
e sender and
delete the material from any computer.

Furthermore, the information contained in this message, and any attachmen=
ts thereto, is
for information purposes only and may contain the personal views and opin=
ions of the=20
author, which are not necessarily the views and opinions of the company.
#########################################################################=
####################

[Ndoc-users] FW: Setting XML documentation for website assembly

[Greg Q. <Gre...@de...>]

Is anybody on this list? I'm not getting any mails at all from this
list.
Thanks

=20

From: Greg Quinn=20
Sent: 17 April 2007 02:14 PM
To: ndo...@li...
Subject: Setting XML documentation for website assembly

=20

Hi,

=20

I am using Visual Studio 2005 and Ndoc 2.0.0.0

I have a webservice I have compiled into an assembly.

=20

However in the generated documentation, none of the methods, even though
all with correct summary tags, have a description.

I believe this problem to be in that the website is not generating the
XML documentation file necessary for NDoc.

=20

Now the question, where do I set the option in Visual Studio 2005 for
the website/webservice to generate the XML documentation? I can see this
option for normal Windows apps. But not for a website.

=20

Thanks

=20


#########################################################################=
####################
The information transmitted is intended only for the person or entity to =
which it=20
is addressed and may contain confidential and/or privileged material.=20
Any review, retransmission, dissemination or other use of, or taking of a=
ny action
in reliance upon, this information by persons or entities other than the =
intended=20
recipient is prohibited. If you received this in error, please contact th=
e sender and
delete the material from any computer.

Furthermore, the information contained in this message, and any attachmen=
ts thereto, is
for information purposes only and may contain the personal views and opin=
ions of the=20
author, which are not necessarily the views and opinions of the company.
#########################################################################=
####################

Re: [Ndoc-users] FW: Setting XML documentation for website assembly

[Mark I. <mi...@so...>]

>From Kevin Downs (26th July 2006):

=20

=20

I have decided to discontinue work on NDoc 2.0 and no longer participate
in any open-source development work.

=20

The development and release of NDoc 1.3 was a huge amount of work, and
by all accounts widely appreciated. Unfortunately, despite the almost
ubiquitous use of NDoc, there has been no support for the project from
the .Net developer community either financially or by development
contributions. Since 1.3 was released, there have been the grand total
of eleven donations to the project. In fact, were it not for Oleg
Tkachenko's kind donation of a MS MVP MSDN subscription, I would not
even have a copy of VS2005 to work with!=20

=20

To put this into perspective, if only roughly 1-in-10 of the those who
downloaded NDoc had donated the minimum allowable amount of $5 then I
could have worked on NDoc 2.0 full-time and it could have been released
months ago! Now, I am not suggesting that this should have occurred, or
that anyone owes me anything for the work I have done, rather I am
trying to demonstrate that if the community values open-source projects
then it should do *something* to support them. MS has for years
acknowledged community contributions via the MVP program but there is
absolutely no support for community projects.

=20

Once 'Sandcastle' is released, it is my belief that it will become the
de-facto standard and that NDoc will slowly become a stagnant
side-water. This will happen regardless of technical considerations,
even if Sandcastle were to be less feature-complete. It's just an
inevitable result of MS's 'not-invented-here' mentality, one only has to
look at Nant and NUnit to see the effects of MS 'competition'.=20

=20

This is not, however, my only reason for stopping development work - I
have a big enough ego to think I could still produce a better product
than them :-)

=20

As some of you are aware, there are some in the community who believe
that a .Net 2.0 compatible release was theirs by-right and that I should
be moving faster - despite the fact that I am but one man working in his
spare time...

=20

This came to head in the last week; I have been subjected to an
automated mail-bomb attack on both my public mail addresses and the
ndoc2 mailing list address. These mails have been extremely offensive
and resulted in my ISP temporarily suspending my account because of the
traffic volume. This incident has been reported to the local
authorities, although I am highly doubtful they will be able to do
anything about it.

=20

This has was the 'last-straw' and has convinced me that I should
withdraw from the community; I'm not prepared to have myself and my
family threatened by some lunatic!=20

=20

Kevin

=20

P.S. If anyone wants to take over as admin on the SourceForge NDoc
project - contact me. If not, I'll be removing myself in 14 days.

=20

=20

=20

=20

Mark

=20

________________________________

From: ndo...@li...
[mailto:ndo...@li...] On Behalf Of Greg
Quinn
Sent: 19 April 2007 15:11
To: ndo...@li...
Subject: [Ndoc-users] FW: Setting XML documentation for website assembly

=20

Is anybody on this list? I'm not getting any mails at all from this
list.
Thanks

=20

From: Greg Quinn=20
Sent: 17 April 2007 02:14 PM
To: ndo...@li...
Subject: Setting XML documentation for website assembly

=20

Hi,

=20

I am using Visual Studio 2005 and Ndoc 2.0.0.0

I have a webservice I have compiled into an assembly.

=20

However in the generated documentation, none of the methods, even though
all with correct summary tags, have a description.

I believe this problem to be in that the website is not generating the
XML documentation file necessary for NDoc.

=20

Now the question, where do I set the option in Visual Studio 2005 for
the website/webservice to generate the XML documentation? I can see this
option for normal Windows apps. But not for a website.

=20

Thanks

=20

________________________________

 The information transmitted is intended only for the person or entity
to which it is addressed and may contain confidential and/or privileged
material. Any review, retransmission, dissemination or other use of, or
taking of any action in reliance upon, this information by persons or
entities other than the intended recipient is prohibited. If you
received this in error, please contact the sender and delete the
material from any computer.

Furthermore, the information contained in this message, and any
attachments thereto, is for information purposes only and may contain
the personal views and opinions of the author, which are not necessarily
the views and opinions of the company.

________________________________

=20

Re: [Ndoc-users] FW: Setting XML documentation for website assembly

[Ferdinand P. <fp...@op...>]

Hello Greg,

It will be just that nobody knows the answer :-) Me neither. You could=20
play with csc /doc:<file.xml>. NDoc wants these files.xml.

Best regards,
Ferda




"Greg Quinn" <Gre...@de...>=20
Sent by: ndo...@li...
19.04.2007 16:10

To
<ndo...@li...>
cc

Subject
[Ndoc-users] FW: Setting XML documentation for website assembly






Is anybody on this list? I?m not getting any mails at all from this list.
Thanks
=20
From: Greg Quinn=20
Sent: 17 April 2007 02:14 PM
To: ndo...@li...
Subject: Setting XML documentation for website assembly
=20
Hi,
=20
I am using Visual Studio 2005 and Ndoc 2.0.0.0
I have a webservice I have compiled into an assembly.
=20
However in the generated documentation, none of the methods, even though=20
all with correct summary tags, have a description.
I believe this problem to be in that the website is not generating the XML =

documentation file necessary for NDoc.
=20
Now the question, where do I set the option in Visual Studio 2005 for the=20
website/webservice to generate the XML documentation? I can see this=20
option for normal Windows apps. But not for a website.
=20
Thanks
=20

 The information transmitted is intended only for the person or entity to=20
which it is addressed and may contain confidential and/or privileged=20
material. Any review, retransmission, dissemination or other use of, or=20
taking of any action in reliance upon, this information by persons or=20
entities other than the intended recipient is prohibited. If you received=20
this in error, please contact the sender and delete the material from any=20
computer.
Furthermore, the information contained in this message, and any=20
attachments thereto, is for information purposes only and may contain the=20
personal views and opinions of the author, which are not necessarily the=20
views and opinions of the company.

 -------------------------------------------------------------------------
This SF.net email is sponsored by DB2 Express
Download DB2 Express C - the FREE version of DB2 express and take
control of your XML. No limits. Just data. Click to get it now.
http://sourceforge.net/powerbar/db2/
=5F=5F=5F=5F=5F=5F=5F=5F=5F=5F=5F=5F=5F=5F=5F=5F=5F=5F=5F=5F=5F=5F=5F=5F=5F=
=5F=5F=5F=5F=5F=5F=5F=5F=5F=5F=5F=5F=5F=5F=5F=5F=5F=5F=5F=5F=5F=5F
Ndoc-users mailing list
Ndo...@li...
https://lists.sourceforge.net/lists/listinfo/ndoc-users

Re: [Ndoc-users] FW: Setting XML documentation for website assembly

[Olivier D. <od...@gm...>]

Hi Greg,

In fact, your question isn't related to NDoc, but rather to Visual Studio...
The problem is that there is no (simple) way to have Visual Studio generate
xml doc files when using web site projects. (see
http://forums.microsoft.com/MSDN/ShowPost.aspx?PostID=1479743&SiteID=1)

To me, two options can be used:
- create dummy projects or msbuild scripts that will generate the
documentation out of your sources; see the trick by F. Prantl : /doc:<
file.xml>.

- convert your web site projects to web application projects (NB : this kind
of projects which existed in Visual Studio 2003, are not part of the
standard installation af Visual Studio 2005. You have either to install
"Visual Studio Web Application Projects" :
http://msdn2.microsoft.com/fr-fr/asp.net/aa336618.aspx or the service pack
1.1 for Visual Studio 2005 (which contains this project template). The Web
application projects behave like standard windows projects: you can find the
option to generate the xml doc in the properties of the project under the
Build tab.

Keep in mind that web site projects where shipped because web application
projects where thought too complex to use. That's why (at least do I suppose
so) they don't provide many build settings (they are even not attached to a
real project file). Web application projects are much more powerful and
should be preferred to web sites (and in Visual Studio 2005, they don't
require any more a running IIS on the dev machine).

If you are interrested in an in-depth comparison between the different web
project types Visual Studio 2005 provides you can read these MSDN Magazine
articles:

http://msdn.microsoft.com/msdnmag/issues/07/04/ExtremeASPNET/default.aspx?loc=en:
about the various
asp.net project types
http://msdn.microsoft.com/msdnmag/issues/06/02/CuttingEdge/ : about build
providers : can be interresting if you intend to build your own "build
process"...

Hope this help,

--
Olivier DALET
http://odalet.wordpress.com/

On 4/19/07, Ferdinand Prantl <fp...@op...> wrote:
>
>
> Hello Greg,
>
> It will be just that nobody knows the answer :-) Me neither. You could
> play with csc /doc:<file.xml>. NDoc wants these files.xml.
>
> Best regards,
> Ferda
>
>
>
>  *"Greg Quinn" <Gre...@de...>*
> Sent by: ndo...@li...
>
> 19.04.2007 16:10
>   To
> <ndo...@li...>  cc
>
>  Subject
> [Ndoc-users] FW: Setting XML documentation for website assembly
>
>
>
>
>
>
> Is anybody on this list? I'm not getting any mails at all from this list.
> Thanks
>
> *From:* Greg Quinn *
> Sent:* 17 April 2007 02:14 PM*
> To:* ndo...@li...*
> Subject:* Setting XML documentation for website assembly
>
> Hi,
>
> I am using Visual Studio 2005 and Ndoc 2.0.0.0
> I have a webservice I have compiled into an assembly.
>
> However in the generated documentation, none of the methods, even though
> all with correct summary tags, have a description.
> I believe this problem to be in that the website is not generating the XML
> documentation file necessary for NDoc.
>
> Now the question, where do I set the option in Visual Studio 2005 for the
> website/webservice to generate the XML documentation? I can see this option
> for normal Windows apps. But not for a website.
>
> Thanks
>
>
> ------------------------------
>
>  *The information transmitted is intended only for the person or entity to
> which it is addressed and may contain confidential and/or privileged
> material. Any review, retransmission, dissemination or other use of, or
> taking of any action in reliance upon, this information by persons or
> entities other than the intended recipient is prohibited. If you received
> this in error, please contact the sender and delete the material from any
> computer.*
>
> *Furthermore, the information contained in this message, and any
> attachments thereto, is for information purposes only and may contain the
> personal views and opinions of the author, which are not necessarily the
> views and opinions of the company.*
>
> ------------------------------
>
>  -------------------------------------------------------------------------
> This SF.net email is sponsored by DB2 Express
> Download DB2 Express C - the FREE version of DB2 express and take
> control of your XML. No limits. Just data. Click to get it now.
> http://sourceforge.net/powerbar/db2/_______________________________________________
>
> Ndoc-users mailing list
> Ndo...@li...
> https://lists.sourceforge.net/lists/listinfo/ndoc-users
>
>
> -------------------------------------------------------------------------
> This SF.net email is sponsored by DB2 Express
> Download DB2 Express C - the FREE version of DB2 express and take
> control of your XML. No limits. Just data. Click to get it now.
> http://sourceforge.net/powerbar/db2/
> _______________________________________________
> Ndoc-users mailing list
> Ndo...@li...
> https://lists.sourceforge.net/lists/listinfo/ndoc-users
>
>


-- 
Olivier DALET
---------------------------------
http://odalet.wordpress.com
http://aspadvice.com/blogs/oliviers_net_blog