OpenEuphoria

Re: utility program suggestions

• Posted by Jeremy Cowgar <jeremy at ?owgar?com> May 21, 2008
• 774 views

Kenneth Rhodes wrote:
> 
> 
> Exactly. My vision is to have a utility program which not only update
> Euphoria core language support, but also generate context sensitive help
> support files for Euphoria and "external" third party libraries and at 
> least color syntax support for non-euphoria editor's such as  Kate, Vim,
> and Jed - further context sensitive help support for external libraries
> could be made available for these editors thru Juergen's EuHTHelp.ex
> command line program.
> 

The new docs for Euphoria are a modified version of the .htx files used in
previous version. It has been greatly simplified and also has very nice PDF and
text generation now also!

http://jeremy.cowgar.com/euphoria/combined.pdf
http://jeremy.cowgar.com/euphoria/combined.txt

(both of those are very old and have been made even better yet)

It also now has inline function documentation that generates Table of Contents,
Alphabetical Indexes, Automatic API Linking, etc...

--**
-- Sort the elements of a sequence into ascending order.
--
-- The elements can be atoms or sequences. The standard compare()
-- routine is used to compare elements.
--
-- Parameters:
--	 x = The sequence to be sorted.
--
-- Returns:
--	 sequence - The original sequence in ascending order
--
-- Comments:
--	 This uses the "Shell" sort algorithm.
--
-- This sort is not "stable", i.e. elements that are considered equal might
-- change position relative to each other.
--
-- Example 1:
--	constant student_ages = {18,21,16,23,17,16,20,20,19}
--	sequence sorted_ages
--	sorted_ages = sort( student_ages )
--	-- result is {16,16,17,18,19,20,20,21,23}
--
-- See Also:
--	 compare
--	 sort_reverse
--	 sort_user
--	 custom_sort

global function sort(sequence x)
...

The doc tool already extracts the documentation and function/procedure
signatures. It probably would not be a far stretch to make it a generic program
extracting the information into a common format that people could use for such
tasks as you are speaking.

Without a common documentation means, though, it would be impossible for a
common program to extract function and documentation from source. It could
potentially know a few different doc styles and do it's best.

--
Jeremy Cowgar
http://jeremy.cowgar.com