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