Re: [nant-dev] Naming of documentation files

[Ian MacLean]

Scott Hernandez wrote:

Sounds great.

Then you are going to add an [attribute] to define each method as a nant
expression engine function? Much like we do for [BuildElement], and
[TaskAttribute] property defs. of tasks.
 

thats right. You can define custom functions like:

///
[CustomFunctionSet]
public class BuiltInFunctions : CustomFunctionSetBase {
   #region String functions
       /// <summary>
       /// Get the length of a string
       /// </summary>
       /// <param name="s">input string</param>
       /// <returns>The strings length</returns>
       [CustomFunction("length")]               
       public int length(string s) {
           return s.Length;
       }    
       ...

}
They will be loaded from the same assemblies that nant currently scans 
for tasks and types.
I've just committed the support for this into the EE-patches branch.   
The next thing I'll look at is namespace support which would be somthing 
like :

[CustomFunctionSet(NameSpaceUri="somenamespace", prefix="foo" )]

That needs some fleshing out though.

Ian



----- Original Message ----- 
From: "Jaroslaw Kowalski" <[EMAIL PROTECTED]>
To: "Gert Driesen" <[EMAIL PROTECTED]>
Cc: <[EMAIL PROTECTED]>
Sent: Tuesday, December 09, 2003 11:01 AM
Subject: Re: [nant-dev] Naming of documentation files

 

I'll use it. I'm quite familiar with XSLT so this shouldn't be a problem.

Do you think that documentation for functions should include anything but
   

a
 

single-line summary + description of all parameters.

Jarek

----- Original Message ----- 
From: "Gert Driesen" <[EMAIL PROTECTED]>
To: "Scott Hernandez" <[EMAIL PROTECTED]>;
<[EMAIL PROTECTED]>
Sent: Tuesday, December 09, 2003 7:21 PM
Subject: Re: [nant-dev] Naming of documentation files

   

would be great if we could use the NAntDocumenter to generate docs for
     

the
 

functions if possible ... that's the only way to ensure that the docs
     

are
 

always in sync ...

Gert
----- Original Message ----- 
From: "Scott Hernandez" <[EMAIL PROTECTED]>
To: <[EMAIL PROTECTED]>
Sent: Tuesday, December 09, 2003 6:35 PM
Subject: Re: [nant-dev] Naming of documentation files

Those files are named based on an old system that was used to create
     

them
 

(fogcreek something or other).

You should name your new files something more reasonable. Those files
     

will
 

get renamed when someone puts in the request for sf.net admins to rename
them in cvs. You can edit them manually, but please make sure you keep
     

them
   

xhtml 1.1 valid.

XSLT/NAntDocumenter are only used to document Tasks and Types (from
     

source
 

code xml comments). The rest of the docs are created from the xhtml in
     

the
 

doc folder.
 ----- Original Message ----- 
 From: Jaroslaw Kowalski
 To: [EMAIL PROTECTED]
 Sent: Tuesday, December 09, 2003 6:07 AM
 Subject: [nant-dev] Naming of documentation files

 Hi!

 Is there any reason why filenames in NAnt help/website are named like
this:
 fog0000000006.html
 fog0000000013.html
 fog0000000040.html
 fog0000000041.html
 fog0000000042.html
 fog0000000079.html
 fog0000000081.html
 I'd like to add a section on expressions and functions. How should I
     

name
   

the files?
 Should I use XSLT/NAntDocumenter to generate the documentation or can
     

it
 

be done by hand?

 Jarek



-------------------------------------------------------
This SF.net email is sponsored by: SF.net Giveback Program.
Does SourceForge.net help you be more productive?  Does it
help you create better code?  SHARE THE LOVE, and help us help
YOU!  Click Here: http://sourceforge.net/donate/
_______________________________________________
nant-developers mailing list
[EMAIL PROTECTED]
https://lists.sourceforge.net/lists/listinfo/nant-developers
     

-------------------------------------------------------
This SF.net email is sponsored by: SF.net Giveback Program.
Does SourceForge.net help you be more productive?  Does it
help you create better code?  SHARE THE LOVE, and help us help
YOU!  Click Here: http://sourceforge.net/donate/
_______________________________________________
nant-developers mailing list
[EMAIL PROTECTED]
https://lists.sourceforge.net/lists/listinfo/nant-developers
   



-------------------------------------------------------
This SF.net email is sponsored by: SF.net Giveback Program.
Does SourceForge.net help you be more productive?  Does it
help you create better code?  SHARE THE LOVE, and help us help
YOU!  Click Here: http://sourceforge.net/donate/
_______________________________________________
nant-developers mailing list
[EMAIL PROTECTED]
https://lists.sourceforge.net/lists/listinfo/nant-developers
 



--
Ian MacLean, Developer, 
ActiveState, a division of Sophos
http://www.ActiveState.com



-------------------------------------------------------
This SF.net email is sponsored by: SF.net Giveback Program.
Does SourceForge.net help you be more productive?  Does it
help you create better code?  SHARE THE LOVE, and help us help
YOU!  Click Here: http://sourceforge.net/donate/
_______________________________________________
nant-developers mailing list
[EMAIL PROTECTED]
https://lists.sourceforge.net/lists/listinfo/nant-developers