[m-rev.] for review: document Java methods for manipulating Mercury lists

[Ian MacLarty]

On Thu, Jan 14, 2010 at 1:30 PM, Julien Fischer
<juliensf at csse.unimelb.edu.au> wrote:
>
> On Tue, 12 Jan 2010, Ian MacLarty wrote:
>
>> doc/reference_manual.texi:
>>   Document how Mercury lists can be manipulated in Java code.
>>
>>   Also document that one should use the equals method to
>>   compare bool and comparison_result values in Java code.
>
> ...
>
>> +Mercury lists can be manipulated by Java code using the following static
>> +methods in the @samp{jmercury.list} package.
>> +
>> + at example
>> +public static boolean is_empty(List_1 lst); /* test if a list is empty */
>> +public static Object det_head(List_1 lst); /* get the head of a non-empty
>> list */
>> +public static List_1 det_tail(List_1 lst); /* get the tail of a non-empty
>> list */
>> +public static List_1 empty_list(); /* create an empty list */
>> +public static List_1 cons(Object H, List_1 T); /* construct a list with
>> the given head and tail */
>> + at end example
>
> Aren't the list methods already listed further down in this section?
>

So they are.  However these don't say in which package the methods
reside.  Also ListIterator isn't documented.  I propose to replace the
existing description with my new one.

Ian.

--------------------------------------------------------------------------
mercury-reviews mailing list
Post messages to:       mercury-reviews at csse.unimelb.edu.au
Administrative Queries: owner-mercury-reviews at csse.unimelb.edu.au
Subscriptions:          mercury-reviews-request at csse.unimelb.edu.au
--------------------------------------------------------------------------