1 /* ----------------------------------------------------------------------------- 2 * rubystdautodoc.swg 3 * 4 * This file contains autodocs for standard STL functions. 5 * ----------------------------------------------------------------------------- */ 6 7 // 8 // For STL autodocumentation 9 // 10 AUTODOC(c_str, "Convert class to a String representation"); 11 AUTODOC(begin, "Return an iterator to the beginning of the $class"); 12 AUTODOC(end, "Return an iterator to past the end of the $class"); 13 AUTODOC(rbegin, "Return a reverse iterator to the beginning (the end) of the $class"); 14 AUTODOC(rend, "Return a reverse iterator to past the end (past the beginning) of the $class"); 15 AUTODOC(length, "Size or Length of the $class"); 16 AUTODOC(replace, "Replace all or a portion of the $class"); 17 AUTODOC(resize, "Resize the size of the $class"); 18 AUTODOC(capacity, "Reserved capacity of the $class"); 19 AUTODOC(reserve, "Reserve memory in the $class for a number of elements"); 20 AUTODOC(erase, "Delete a portion of the $class"); 21 AUTODOC(max_size, "Maximum size of elements allowed in the $class"); 22 AUTODOC(iterator, "Return an iterator to the $class"); 23 AUTODOC(empty, "Check if the $class is empty or not"); 24 AUTODOC(rfind, "Find an element in reverse usually starting from the end of the $class"); 25 AUTODOC(assign, "Assign a new $class or portion of it"); 26 AUTODOC(front, "Return the first element in $class"); 27 AUTODOC(back, "Return the last element in $class"); 28 AUTODOC(second, "Return the second element in $class"); 29 AUTODOC(push_front, "Add an element at the beginning of the $class"); 30 AUTODOC(push_back, "Add an element at the end of the $class"); 31 AUTODOC(pop_front, "Remove and return element at the beginning of the $class"); 32 AUTODOC(pop_back, "Remove and return an element at the end of the $class"); 33 AUTODOC(clear, "Clear $class contents"); 34
