Re: [ecf-dev] ECF API Docs

[Scott Lewis <slewis@xxxxxxxxxxxxx>]

Hi Ken,

Ken Gilmer wrote:
> Understood.  This effort is something I'd like to contribute to.  

Sure...that would be great.  Just name a section/API that you want to 
work on and I won't touch it.  I'm going to be working on the Core and 
FileTransfer APIs first (today...Wed...and over next few days).

If others want to contribute also please just speak up and identify a 
section that you would be interested in doing.

> Additionally, I'm interested in the dynamic generation of 
> documentation from javadocs and bundle manifests from a "day job" 
> context.  I've added myself to the bugzilla.  Any recommendations 
> where I should dig in on this doc effort?

AFAIK, the bug entry that I made is the only traffic on this particular 
documentation thread.  Chris A might have more direct insight into any 
PDE team's plans WRT bundle-level documentation generation.  Chris?

I suspect that the first working prototype implementation that's 
presented to PDE team will speak pretty loudly.  I would like to do it 
myself, but can't reasonably commit to it.

At some point in the past Jeff M indicated to me that there may be some 
work on javadocs generation for OSGi bundles elsewhere, but I couldn't 
find it with a simple Google search.  Also...I think it would make sense 
to optionally include extension points docs (along with OSGi service docs).

Scott


> -Ken
>
> On Apr 11, 2007, at 12:14 PM, Scott Lewis wrote:
>
> > Hi Ken,
> >
> > Ken Gilmer wrote:
> > > This looks like a great idea Scott.  How are the javadocs associated 
> > > though?
> >
> > I was thinking that on the bundle pages in the Exported Packages area 
> > that the packages would be linked to the javadocs for that package.  
> > Crude, but if it's by hand (which it is), probably the most that can 
> > be done right now.  Ideally I would like to work on a doclet that 
> > would generate a lot of this via access to manifest.mf, etc...but 
> > that's for another day.
> >
> > Scott
> >
> > > -ken
> > >
> > > On Apr 10, 2007, at 9:08 PM, Scott Lewis wrote:
> > >
> > > > Hi Folks,
> > > >
> > > > I've started some new ECF API docs linking ECF APIs to bundles to 
> > > > package and class-level javadocs.  Any comments appreciated 
> > > > (content and/or formatting, etc) before I go much further.
> > > >
> > > > http://wiki.eclipse.org/index.php/ECF_API_Docs
> > > >
> > > > Thanks,
> > > >
> > > > Scott
> > > > _______________________________________________
> > > > ecf-dev mailing list
> > > > ecf-dev@xxxxxxxxxxx
> > > > https://dev.eclipse.org/mailman/listinfo/ecf-dev
> > >
> > > _______________________________________________
> > > ecf-dev mailing list
> > > ecf-dev@xxxxxxxxxxx
> > > https://dev.eclipse.org/mailman/listinfo/ecf-dev
> >
> > _______________________________________________
> > ecf-dev mailing list
> > ecf-dev@xxxxxxxxxxx
> > https://dev.eclipse.org/mailman/listinfo/ecf-dev
>
> _______________________________________________
> ecf-dev mailing list
> ecf-dev@xxxxxxxxxxx
> https://dev.eclipse.org/mailman/listinfo/ecf-dev