Christoph Pospiech <christoph.pospi...@de.ibm.com> wrote on 01/24/2010
10:17:27 AM:
> In general, I have to admit that I am feeling quite lost as a user,
because
> the resources in http://x10.codehaus.org/For+Users, particularly the
> tutorials, detail at length about the general concepts. This is good for
a
> general understanding. But for writing your own programs, you don't want
to
> start from scratch. Instead, you would need details on the classes
> and methods
> as provided in http://dist.codehaus.org/x10/xdoc/2.0/. This site provides
the
> formal definitions, but not the functionality of these methods and
classes -
> you can only guess from the name.
>
> I know that writing documentation is always tedious and may appear lost
work,
> when things are still on the move. But would it be possible to copy some
of
> the comment lines from the code of the methods and classes (assuming that

> there are any) to the description in
http://dist.codehaus.org/x10/xdoc/2.0/,
> say marked as "additional hint" ?
> --

The problem is mainly that there aren't enough comments.  We're working on
it...

We posted a refresh of the x10doc on x10-lang.org a few minutes ago that
(a) has more comments on a few more key classes in x10.lang (still lots to
do unfortunately) and (b) only includes the public/protected methods (as is
standard for javadoc in Java).  The later should help make it easier to see
at a glance what the intended public API of the various classes is.

--dave
------------------------------------------------------------------------------
The Planet: dedicated and managed hosting, cloud storage, colocation
Stay online with enterprise data centers and the best network in the business
Choose flexible plans and management services without long-term contracts
Personal 24x7 support from experience hosting pros just a phone call away.
http://p.sf.net/sfu/theplanet-com
_______________________________________________
X10-users mailing list
X10-users@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/x10-users

Reply via email to