Difference between revisions of "API Article"

Latest revision as of 04:19, 1 April 2011

Definition

Article( string word) -> string out

Description

prepends the appropriate article to the string word

Arguments

Type	Name	Description
string	word	string to prepend an article to.

Returns

Type	Name	Description
string	out	the string with an article prepended.

Notes

Example:

Article("apple") -> "an apple"

@@ Line 1: / Line 1: @@
-=== Article ===
+{{Function
-'''Definition:'''<br>
+| name         = Article
-Article(string ''word'') -> string ''out''
+| desc         = prepends the appropriate article to the string ''word''
-<br>
+| arg1_name    = word
-'''Description:'''<br>
+| arg1_type    = string
-prepends the appropriate article to the string ''word''
+| arg1_desc    = string to prepend an article to.
-<br>
+| ret1_name    = out
-'''Arguments:'''<br>
+| ret1_type    = string
-''word'' string to prepend an article to.
+| ret1_desc    = the string with an article prepended.
-<br>
+| notes        = '''Example''':<br>
-'''Returns:'''<br>
-''out'' the string with an article prepended.
-<br>
-'''Example''':<br>
 <source lang="lua">Article("apple") -> "an apple"</source><br>
-<br>
+}}