On Thu, 02 Dec 2004 23:44:08 +0900, Ian MacLean <[EMAIL PROTECTED]> wrote:
> well - you'll find that its missing all the descriptions that are
> written as xml doc comments in the c# source. So it works -- its just
> not that useful yet.
>
> Ian
There doesn't appear to be anything missing in the SDK docs generated
on my machine, so they're definitely useful. For example, in the
source for NAnt.Core.Projects, the xml doc comment for the class
reads:
----------
/// <summary>
/// Central representation of a NAnt project.
/// </summary>
/// <example>
/// <para>
/// The <see cref="Run" /> method will initialize the project
with the build
/// file specified in the constructor and execute the default target.
/// </para>
/// <code>
/// <![CDATA[
/// Project p = new Project("foo.build", Level.Info);
/// p.Run();
/// ]]>
/// </code>
/// </example>
/// <example>
/// <para>
/// If no target is given, the default target will be executed
if specified
/// in the project.
/// </para>
/// <code>
/// <![CDATA[
/// Project p = new Project("foo.build", Level.Info);
/// p.Execute("build");
/// ]]>
/// </code>
/// </example>
----------
When I bring up /usr/share/NAnt/doc/sdk/index.html in my browser, I
find all of this information to be present in the main node for
NAnt.Core -> Project Class.
Clicking on the class's Members node also shows descriptions for each
member, and clicking on each member node reveals their particular
documentation.
So if there's anything missing in my generated docs, I'd like to know
about it. :)
-------------------------------------------------------
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://productguide.itmanagersjournal.com/
_______________________________________________
Nant-users mailing list
[EMAIL PROTECTED]
https://lists.sourceforge.net/lists/listinfo/nant-users
