Gecko [ 122.154.134.11 ]

Name	Size	Permission
Makefile.swig	943 B	-rw-r--r--
argcargv.i	1.19 KB	-rw-r--r--
attribute.i	34 B	-rw-r--r--
carrays.i	129 B	-rw-r--r--
cdata.i	30 B	-rw-r--r--
cmalloc.i	32 B	-rw-r--r--
cni.i	42 B	-rw-r--r--
cpointer.i	33 B	-rw-r--r--
cstring.i	32 B	-rw-r--r--
director.swg	8.15 KB	-rw-r--r--
embed.i	169 B	-rw-r--r--
exception.i	126 B	-rw-r--r--
extconf.rb	234 B	-rw-r--r--
factory.i	32 B	-rw-r--r--
file.i	639 B	-rw-r--r--
jstring.i	952 B	-rw-r--r--
progargcargv.i	770 B	-rw-r--r--
ruby.swg	2.59 KB	-rw-r--r--
rubyapi.swg	801 B	-rw-r--r--
rubyautodoc.swg	4.2 KB	-rw-r--r--
rubyclasses.swg	8.8 KB	-rw-r--r--
rubycomplex.swg	3.24 KB	-rw-r--r--
rubycontainer.swg	26.63 KB	-rw-r--r--
rubycontainer_extended.swg	3.47 KB	-rw-r--r--
rubydef.swg	42 B	-rw-r--r--
rubyerrors.swg	3.63 KB	-rw-r--r--
rubyfragments.swg	552 B	-rw-r--r--
rubyhead.swg	3.87 KB	-rw-r--r--
rubyinit.swg	39 B	-rw-r--r--
rubyiterators.swg	22.38 KB	-rw-r--r--
rubykw.swg	1.15 KB	-rw-r--r--
rubymacros.swg	456 B	-rw-r--r--
rubyopers.swg	1.81 KB	-rw-r--r--
rubyprimtypes.swg	5.25 KB	-rw-r--r--
rubyrun.swg	13.36 KB	-rw-r--r--
rubyruntime.swg	423 B	-rw-r--r--
rubystdautodoc.swg	1.7 KB	-rw-r--r--
rubystdcommon.swg	6.45 KB	-rw-r--r--
rubystdfunctors.swg	4.07 KB	-rw-r--r--
rubystrings.swg	1.62 KB	-rw-r--r--
rubytracking.swg	5.19 KB	-rw-r--r--
rubytypemaps.swg	1.76 KB	-rw-r--r--
rubyuserdir.swg	409 B	-rw-r--r--
rubywstrings.swg	2.34 KB	-rw-r--r--
std_alloc.i	27 B	-rw-r--r--
std_basic_string.i	2.58 KB	-rw-r--r--
std_char_traits.i	33 B	-rw-r--r--
std_common.i	1.05 KB	-rw-r--r--
std_complex.i	471 B	-rw-r--r--
std_container.i	60 B	-rw-r--r--
std_deque.i	732 B	-rw-r--r--
std_except.i	35 B	-rw-r--r--
std_functors.i	768 B	-rw-r--r--
std_ios.i	380 B	-rw-r--r--
std_iostream.i	227 B	-rw-r--r--
std_list.i	1.01 KB	-rw-r--r--
std_map.i	10.85 KB	-rw-r--r--
std_multimap.i	5.9 KB	-rw-r--r--
std_multiset.i	1.37 KB	-rw-r--r--
std_pair.i	5.21 KB	-rw-r--r--
std_queue.i	851 B	-rw-r--r--
std_set.i	5.82 KB	-rw-r--r--
std_sstream.i	30 B	-rw-r--r--
std_stack.i	853 B	-rw-r--r--
std_streambuf.i	31 B	-rw-r--r--
std_string.i	190 B	-rw-r--r--
std_vector.i	1.19 KB	-rw-r--r--
std_vectora.i	950 B	-rw-r--r--
std_wstring.i	65 B	-rw-r--r--
stl.i	519 B	-rw-r--r--
timeval.i	1 KB	-rw-r--r--
typemaps.i	11.21 KB	-rw-r--r--

Code Editor : rubyautodoc.swg

/**
 * @file   rubyautodoc.swg
 * @author gga
 * @date   Wed May  2 16:41:59 2007
 * 
 * @brief  This file implements autodoc typemaps for some common
 *         ruby methods.
 * 
 * 
 */

%define AUTODOC(func, str)
  %feature("autodoc", str) func;
%enddef

AUTODOC(to_i, "Convert $class to an Integer");
AUTODOC(to_f, "Convert $class to a Float");
AUTODOC(coerce, "Coerce class to a number");
AUTODOC(to_a, "Convert $class to an Array");
AUTODOC(to_s, "Convert class to a String representation");
AUTODOC(inspect, "Inspect class and its contents");

AUTODOC(at, "Return element at a certain index");
AUTODOC(__getitem__, "Element accessor/slicing");
AUTODOC(__setitem__, "Element setter/slicing");
AUTODOC(slice, "Return a slice (portion of) the $class");

AUTODOC(push, "Add an element at the end of the $class");
AUTODOC(pop, "Remove and return element at the end of the $class");
AUTODOC(shift, "Remove and return element at the beginning of the $class");
AUTODOC(unshift, "Add one or more elements at the beginning of the $class");
AUTODOC(first, "Return the first element in $class");
AUTODOC(last, "Return the last element in $class");

//
// Common Object methods
//
AUTODOC(hash, "Hashing function for class");
AUTODOC(dup, "Create a duplicate of the class and unfreeze it if needed");
AUTODOC(clone, "Create a duplicate of the class");

//
// Container methods
//
AUTODOC(empty, "Check if $class is empty");
AUTODOC(size, "Size or Length of the $class");
AUTODOC(insert, "Insert one or more new elements in the $class");

//
// Iterator methods (block)
//
AUTODOC(each, "Iterate thru each element in the $class.  A block must be provided");
AUTODOC(find, "Find an element in the class");
AUTODOC(each_key, "Iterate thru each key element in the $class.  A block must be provided");
AUTODOC(each_value, "Iterate thru each key element in the $class.  A block must be provided");
AUTODOC(reject, "Iterate thru each element in the $class and reject those that fail a condition returning a new $class.  A block must be provided");
AUTODOC(reject_bang, "Iterate thru each element in the $class and reject those that fail a condition.  A block must be provided.  $class is modified in place");
AUTODOC(select, "Iterate thru each element in the $class and select those that match a condition.  A block must be provided");
AUTODOC(delete_at, "Delete an element at a certain index");
AUTODOC(__delete__, "Delete a matching element");

//
// Hash methods
//
AUTODOC(keys, "Return an Array of key elements");
AUTODOC(values, "Return an Array of value elements");
AUTODOC(values_at, "Return an Array of value elements matching the conditions");

//
// Operators
//
#ifdef __cplusplus
AUTODOC(operator==, "Equality comparison operator");
AUTODOC(operator<=, "Lower or equal comparison operator");
AUTODOC(operator>=, "Higher or equal comparison operator");
AUTODOC(operator<, "Lower than comparison operator");
AUTODOC(operator>, "Higher than comparison operator");
AUTODOC(operator<<, "Left shifting or appending operator");
AUTODOC(operator>>, "Right shifting operator or extracting operator");
AUTODOC(operator+, "Add operator");
AUTODOC(operator-, "Substraction operator");
AUTODOC(operator+(), "Positive operator");
AUTODOC(operator-(), "Negation operator");
AUTODOC(operator&, "AND operator");
AUTODOC(operator|, "OR operator");
AUTODOC(operator^, "XOR operator");
AUTODOC(operator~, "Invert operator");
#endif
AUTODOC(__eq__, "Equality comparison operator");
AUTODOC(__le__, "Lower or equal comparison operator");
AUTODOC(__ge__, "Higher or equal comparison operator");
AUTODOC(__lt__, "Lower than comparison operator");
AUTODOC(__gt__, "Higher than comparison operator");
AUTODOC(__lshift__, "Left shifting or appending operator");
AUTODOC(__rshift__, "Right shifting operator or extracting operator");
AUTODOC(__add___, "Add operator");
AUTODOC(__sub__, "Substraction operator");
AUTODOC(__pos__, "Positive operator");
AUTODOC(__neg__, "Negation operator");
AUTODOC(__and__, "AND operator");
AUTODOC(__or__, "OR operator");
AUTODOC(__xor__, "XOR operator");
AUTODOC(__negate__, "Invert operator");
AUTODOC(__pow__, "Exponential operator");
AUTODOC(__divmod__, "Modulo of division");
AUTODOC(__cmp__, "Comparison operator.  Returns < 0 for less than, 0 for equal or > 1 for higher than.");

${this.title}

Code Editor : rubyautodoc.swg