Ian

Here is the csc and ndoc tasks from my build file.

<csc target="library" warnaserror="true" debug="true" define="" 
output="build/bin/Nant.MyTasks.dll" doc="build/bin/Nant.MyTasks.xml">
            <nowarn>
                <!-- do not report warnings for missing XML comments -->
                <warning number="1591" />
                <!-- do not report deprecation warnings -->
                <warning number="0618" />
            </nowarn>
            <sources>
    <exclude name="tests/**/*.cs" />
    <include name="**/*.cs" />
            </sources>
            <references>
                <include name="bin/NAnt.Core.dll" />
                <include name="bin/NAnt.DotNetTasks.dll" />
                <include name="bin/log4net.dll" />
                 <include name="Microsoft.SqlServer.DTSPkg80.dll" />

            </references>
        </csc>

 
   <target name="doc" depends="build" description="build documentation">
   <ndoc>
                <assemblies basedir="build/bin">
                <include name="bin/NAnt.Core.dll" />
                    <include name="Nant.MyTasks.dll" />
                </assemblies>
                <documenters>
                    <documenter name="NAnt">
                        <property name="OutputDirectory" value="build/doc/help" 
/>
                        <property name="SdkDocVersion" value="SDK_v1_1" />
                        <property name="SdkLinksOnWeb" value="true" />
                        <!-- set base uri used for linking to other NAnt docs 
-->
                        <property name="NAntBaseUri" value="../" />
                        <!-- do not filter on namespace -->
                        <property name="NamespaceFilter" value="Nant.MyTasks" />
                        <!-- set the name and version of the product for which 
docs are generated -->
                        <property name="ProductName" value="My Nant Tasks" />
                        <property name="ProductVersion" value=".85" />
                        <property name="ProductUrl" 
value="http://nant.sourceforge.net"; />                        
                        <property name="Preliminary" 
value="${not(project.release.type == 'release')}" />
                        <property name="DocumentAttributes" value="True" />
                        <property name="IncludeAssemblyVersion" value="True" />
                        <property name="ShowMissingParams" value="True" />
                        <property name="ShowMissingReturns" value="True" />
                        <property name="ShowMissingValues" value="True" />
                    </documenter>
                </documenters>
            </ndoc>
    </target>


________________________________

From: Ian MacLean [mailto:[EMAIL PROTECTED]
Sent: Wed 2/16/2005 1:38 AM
To: James, Justin
Cc: nant-developers@lists.sourceforge.net
Subject: Re: [nant-dev] Documentor




Hi Justin,

James, Justin wrote:

>What are the requirements for the Nant Documentor to actually generator the 
>nant style documentation?  I have a bunch of custom task that I have built but 
>when I use the nant documentor all of the tasks/properties/types show up in 
>the web output but it does not include any of the xml comments such as 
>comments and code samples. 
>
> 
>
Do you pass the appropriate doc= "" attribute on the <csc> task when you
build your custom tasks ? If you post the build file you are using -
showing the ndoc invocation I may be able to tell you why its not
outputting the comments.

Ian




-------------------------------------------------------
SF email is sponsored by - The IT Product Guide
Read honest & candid reviews on hundreds of IT Products from real users.
Discover which products truly live up to the hype. Start reading now.
http://ads.osdn.com/?ad_ide95&alloc_id396&op=click
_______________________________________________
nant-developers mailing list
nant-developers@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/nant-developers

Reply via email to