dev@fi.java.net

Re: FI needs more documentation

From: Joe Wang <joe.wang_at_sun.com>
Date: Thu, 03 Feb 2005 10:28:16 -0800

Paul Sandoz wrote:

> Hi Kohsuke,
>
> You are absolutely correct. This is something i will actively work on
> and get something produced for next week.
>
> Joe you said that you had created some samples, can we use this as a
> start and expand on this?

I was distracted from completing the samples as I planned to, trying to
do too much at the same time :) Here's what I have so far:
samples
    readme (need to do)
    ant build file (need to do)
    -sax
          -DocumentSerializer (done)
          -DocumentParser (need to add)
    -stax
          -StreamReader (done)
          -Serializer (done)
          -EventReader (done)
          -FIDocReader (a simple FI Doc editor with Notepad-like
interface, need to do)

I totally agree with Kohsuke. So I need to add more helpful comments to
these samples and a general get-started readme, as well as an ant ZIP
task. I'll check in what I have.

Joe

>
> Paul.
>
> Kohsuke Kawaguchi wrote:
>
>>
>> I noticed that FI lacks documentation.
>>
>> For example, if I'm an ordinary Java developer trying to use FI, I'd
>> need a document that tells me:
>>
>> - what it means to "use FI"
>> - how I can replace my SAX/StAX/DOM parser with FI
>>
>> It would be also nice if there's a downloadable zip file with
>> license, jar, javadoc, and those documentations. You know, the usual
>> stuff you get from other projects.
>>
>> If some of us can write them and put together an ant task to make a
>> zip file, I can tweak Hudson to post it to documents&files section
>> for each build.
>>
>