dev@fi.java.net

Re: FI needs more documentation

From: Paul Sandoz <Paul.Sandoz_at_Sun.COM>
Date: Thu, 03 Feb 2005 18:17:06 +0100

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
>

Note that there is some meager documentation on the scripts that can be
used to create FI documents from XML documents and vice versa.

https://fi.dev.java.net/source/browse/fi/FastInfoset/README.txt?rev=1.1.1.1&view=markup

but we need to have more samples that are clearly documented.

Documenting the conversion classes, which are used by the scripts, would
be a good start:

https://fi.dev.java.net/source/browse/fi/FastInfoset/src/com/sun/xml/fastinfoset/tools/

Paul.

> 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.
>

-- 
| ? + ? = To question
----------------\
    Paul Sandoz
         x38109
+33-4-76188109