xmlgraphics-fop-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From mehdi houshmand <med1...@gmail.com>
Subject Re: svn commit: r1234877 - in /xmlgraphics/fop/trunk: examples/embedding/java/embedding/ examples/embedding/java/embedding/atxml/ src/java/org/apache/fop/cli/ src/java/org/apache/fop/render/ src/java/org/apache/fop/render/awt/ src/java/org/apache/fop
Date Wed, 25 Jan 2012 14:59:48 GMT
I've spent some time looking through the examples and the
documentation above and I think the classes listed below are all the
classes necessary for most the use-cases and thus should be considered
the public API.

org.apache.fop.apps.*
org.apache.fop.fo.FOEventHandler
org.apache.fop.fonts.FontManager
org.apache.fop.events.EventListener
org.apache.fop.events.Event
org.apache.fop.events.model.EventSeverity
org.apache.fop.render.RendererFactory
org.apache.fop.render.intermediate.IFDocumentHandler
org.apache.fop.render.intermediate.IFParser
org.apache.fop.render.intermediate.IFUtil
org.apache.fop.render.intermediate.IFSerializer
org.apache.fop.render.intermediate.IFContext

This would mean deprecating
o.a.f.apps.FOUserAgent.setRendererOverride(...) since (if I'm not
mistaken) this is legacy code to bind a MIME type to IF output.
Obviously I would also give instructions to use the IFDocumentHandler
implementation. Also, while we're at it, the IFDocumentHandler method
isn't described on the link above, so I'll try and put some
information there as well.

I plan to put this information on the website, so please feel free to
discuss if you have any questions and/or wish to make amendments.

Mehdi
On 24 January 2012 19:36, Glenn Adams <glenn@skynav.com> wrote:
>
> On Tue, Jan 24, 2012 at 10:08 AM, Vincent Hennebert <vhennebert@gmail.com>
> wrote:
>>
>> I would consider to be part of the public API the code that is present
>> on the following page:
>> http://xmlgraphics.apache.org/fop/trunk/embedding.html
>>
>
> I agree. We should distinguish between APIs documented as being explicitly
> part of the embedding APIs and other public interfaces/members not
> documented as such.
>
> Also, it is probably good to review, at least during every release, whether
> the embedding API documentation is correct and complete.

Mime
View raw message