3. Alphabetical Listing of all Routines

comment

Syntax: bool = comment(sequence line)
Description: Returns TRUE is line is a comment, FALSE otherwise



error

Syntax: error(s)
Description: Prints out string passed to error and then aborts with an exit status of 1.



generate_html

Syntax: generate_html()
Description: Takes the data colected in Library_header and Routines and creates the HTML documentation from it that looks like the documentation created by RDS.
Comments: Very ugly coding when it comes to outputting the HTML



get_command_line_options

Syntax: get_command_line_options()
Description: Gets the file names off the command line and sets Filenums to their file handles.



print_data

Syntax: print_data(x)
Description: This routine outputs the Euphoria data for Library_header and Routines. If x is a sequence then the data is output to a file with that name, if x is an integer representing an open file then the data is outputted to that file.
Comments: This routine is only used while debugging.



read_line

Syntax: read_line(sequence command, sequence line)
Description: Reads the line and gets the data for documentating program.
See Also: generate_html



see_also_links

Syntax: s = see_also_links(sequence filename, sequence routine_names)
Description: Takes the name of a file and a string of routine names and returns a string of HTML that has links to every routine in the file with that the name passed. Needed for parsing "See Also" info.
See Also: generate_html



trim

Syntax: s1 = trim(s2)
Description: Removes leading spaces and '-'s from a string.



trim_comment

Syntax: s1 = trim(s2)
Description: Same as trim instead it just removes "--" from the beginning of the string.
Comments: Only used in read_line
See Also: read_line