Namespace doc::util

Method Summary

The namespace doc::util currently contains no public methods.

Method Detail

* indicates required

Private Methods:

doc::sort_@see

procedure to deal with @see comments

doc::util::bracket_space

puts a space after all closing curly brackets, does not add a space when brackets are already followed by a space

doc::util::dbl_colon_fix

doc::util::escape_square_brackets

escapes out all square brackets

doc::util::find_marker_indices

given a body of text and a text marker, returns a list of position indices for each occurrence of the text marker Parameters: text * body of text to be searched through marker * the text-divider mark Returns: list of indices of the position immediately preceding each occurrence of the text marker; if there are no occurrences of the text marker, returns a zero-element list See Also: namespace - doc proc - doc::parse_file doc::parse_namespace doc::util::text_divider

doc::util::make_text_listable

doc::util::sort_see

used to sort the see list, which has structure {[name} name type type url url \] Parameters: element1 * the first of the two list elements to be compared element2 * the second of the two elements to be compared

doc::util::text_divider

divides a string variable into a list of strings, all but the first element beginning with the indicated text {marker;} the first element of the created list contains all of the string preceding the first occurrence of the text marker Parameters: text * name of string variable (not the string value itself) marker * the string indicating text division See Also: proc - doc::util::find_marker_indices

* indicates required