GNU
/
easejs
1
0
Fork 0
Code Releases Activity

Corrected terms in Abstract Members section of documentation 

- "Parameters" instead of "arguments"
- "Declaration", not "definition"
perfodd
Mike Gerwitz 2011-12-21 20:13:42 -05:00
parent a10cf82a12
commit ac837107c5
1 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
doc/classes.texi
View File

@ -1277,17 +1277,17 @@ it is perfectly legal to alter the object:
@node Abstract Members @node Abstract Members
@section Abstract Members @section Abstract Members
@table @code @table @code
@item 'abstract [@var{keywords}] @var{name}': @var{args} @item 'abstract [@var{keywords}] @var{name}': @var{params}
Declare an abstract method @var{name} as having @var{args} arguments, having Declare an abstract method @var{name} as having @var{params} parameters, having
optional additional keywords optional additional keywords
@var{keywords}. @var{keywords}.
@end table @end table
Abstract members permit defining an API, deferring the implementation to a Abstract members permit declaring an API, deferring the implementation to a
subtype. Abstract methods are declared as an array of string argument names subtype. Abstract methods are declared as an array of string parameter names
@var{args}. @var{params}.
@verbatim @verbatim
// declares abstract method 'connect' expecting the two arguments, 'host' // declares abstract method 'connect' expecting the two parameters, 'host'
// and 'path' // and 'path'
{ 'abstract connect': [ 'host', 'path' ] } { 'abstract connect': [ 'host', 'path' ] }
@end verbatim @end verbatim
@ -1304,11 +1304,11 @@ keyword.
@item @item
Currently, only methods may be declared abstract. Currently, only methods may be declared abstract.
@item @item
The subtype must implement at least the number of arguments declared in The subtype must implement at least the number of parameters declared in
@var{args}, but the names needn't match. @var{params}, but the names needn't match.
@itemize @itemize
@item @item
Each name in @var{args} must be a valid variable name, as satisfied by the Each name in @var{params} must be a valid variable name, as satisfied by the
regular expression @code{/^[a-z][a-z0-9]*$/i}. regular expression @code{/^[a-z][a-z0-9]*$/i}.
@item @item
The names are use purely for documentation and are not semantic. The names are use purely for documentation and are not semantic.