You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@any23.apache.org by Lewis John Mcgibbney <le...@gmail.com> on 2012/02/13 19:49:29 UTC
Documenting Plugins
Hi,
What are we meant to do with the documentation.java files in each of the
moduels? Are these meant to be Javadoc components or something? Can someone
please advise what and how I would begin documenting these if I wanted to.
Thanks
Lewis
--
*Lewis*
Re: Documenting Plugins
Posted by Michele Mostarda <mi...@gmail.com>.
Hi Lewis,
the package-info.java files are meant to contain package Javadoc
descriptions.
Some of the packages are already documented. For the missing ones feel free
to fill them, I can review the content for a double check when they're
ready.
Thanks.
Mic
On 14 February 2012 11:32, Lewis John Mcgibbney
<le...@gmail.com>wrote:
> Yeah these ones.
>
>
> https://svn.apache.org/viewvc/incubator/any23/trunk/plugins/basic-crawler/src/main/java/org/apache/any23/plugin/crawler/package-info.java?view=markup
>
> Sorry I should have been more clear.
>
> Thanks
>
>
> On Tue, Feb 14, 2012 at 8:13 AM, Simone Tripodi <simonetripodi@apache.org
> >wrote:
>
> > Hi,
> >
> > did you mean package-info.java?
> >
> > -Simo
> >
> > http://people.apache.org/~simonetripodi/
> > http://simonetripodi.livejournal.com/
> > http://twitter.com/simonetripodi
> > http://www.99soft.org/
> >
> >
> >
> > On Mon, Feb 13, 2012 at 9:40 PM, Michele Mostarda
> > <mi...@gmail.com> wrote:
> > > Hi Lewis,
> > >
> > > On 13 February 2012 19:49, Lewis John Mcgibbney
> > > <le...@gmail.com>wrote:
> > >
> > >> Hi,
> > >>
> > >> What are we meant to do with the documentation.java files in each of
> the
> > >> moduels?
> > >
> > > Are these meant to be Javadoc components or something? Can someone
> > >> please advise what and how I would begin documenting these if I wanted
> > to.
> > >>
> > >>
> > > Which files are talking about ? I cannot find them within the Any23
> > trunk.
> > >
> > >
> > >> Thanks
> > >>
> > >
> > > Bye
> > >
> > > Mic
> > >
> > >>
> > >> Lewis
> > >>
> > >> --
> > >> *Lewis*
> > >>
> > >
> > >
> > >
> > > --
> > > Michele Mostarda
> > > Senior Software Engineer
> > > skype: michele.mostarda
> > > twitter: micmos
> > > mail: me@michelemostarda.com
> > > site : http://www.michelemostarda.com
> >
>
>
>
> --
> *Lewis*
>
--
Michele Mostarda
Senior Software Engineer
skype: michele.mostarda
twitter: micmos
mail: me@michelemostarda.com
site : http://www.michelemostarda.com
Re: Documenting Plugins
Posted by Lewis John Mcgibbney <le...@gmail.com>.
Yeah these ones.
https://svn.apache.org/viewvc/incubator/any23/trunk/plugins/basic-crawler/src/main/java/org/apache/any23/plugin/crawler/package-info.java?view=markup
Sorry I should have been more clear.
Thanks
On Tue, Feb 14, 2012 at 8:13 AM, Simone Tripodi <si...@apache.org>wrote:
> Hi,
>
> did you mean package-info.java?
>
> -Simo
>
> http://people.apache.org/~simonetripodi/
> http://simonetripodi.livejournal.com/
> http://twitter.com/simonetripodi
> http://www.99soft.org/
>
>
>
> On Mon, Feb 13, 2012 at 9:40 PM, Michele Mostarda
> <mi...@gmail.com> wrote:
> > Hi Lewis,
> >
> > On 13 February 2012 19:49, Lewis John Mcgibbney
> > <le...@gmail.com>wrote:
> >
> >> Hi,
> >>
> >> What are we meant to do with the documentation.java files in each of the
> >> moduels?
> >
> > Are these meant to be Javadoc components or something? Can someone
> >> please advise what and how I would begin documenting these if I wanted
> to.
> >>
> >>
> > Which files are talking about ? I cannot find them within the Any23
> trunk.
> >
> >
> >> Thanks
> >>
> >
> > Bye
> >
> > Mic
> >
> >>
> >> Lewis
> >>
> >> --
> >> *Lewis*
> >>
> >
> >
> >
> > --
> > Michele Mostarda
> > Senior Software Engineer
> > skype: michele.mostarda
> > twitter: micmos
> > mail: me@michelemostarda.com
> > site : http://www.michelemostarda.com
>
--
*Lewis*
Re: Documenting Plugins
Posted by Simone Tripodi <si...@apache.org>.
Hi,
did you mean package-info.java?
-Simo
http://people.apache.org/~simonetripodi/
http://simonetripodi.livejournal.com/
http://twitter.com/simonetripodi
http://www.99soft.org/
On Mon, Feb 13, 2012 at 9:40 PM, Michele Mostarda
<mi...@gmail.com> wrote:
> Hi Lewis,
>
> On 13 February 2012 19:49, Lewis John Mcgibbney
> <le...@gmail.com>wrote:
>
>> Hi,
>>
>> What are we meant to do with the documentation.java files in each of the
>> moduels?
>
> Are these meant to be Javadoc components or something? Can someone
>> please advise what and how I would begin documenting these if I wanted to.
>>
>>
> Which files are talking about ? I cannot find them within the Any23 trunk.
>
>
>> Thanks
>>
>
> Bye
>
> Mic
>
>>
>> Lewis
>>
>> --
>> *Lewis*
>>
>
>
>
> --
> Michele Mostarda
> Senior Software Engineer
> skype: michele.mostarda
> twitter: micmos
> mail: me@michelemostarda.com
> site : http://www.michelemostarda.com
Re: Documenting Plugins
Posted by Michele Mostarda <mi...@gmail.com>.
Hi Lewis,
On 13 February 2012 19:49, Lewis John Mcgibbney
<le...@gmail.com>wrote:
> Hi,
>
> What are we meant to do with the documentation.java files in each of the
> moduels?
Are these meant to be Javadoc components or something? Can someone
> please advise what and how I would begin documenting these if I wanted to.
>
>
Which files are talking about ? I cannot find them within the Any23 trunk.
> Thanks
>
Bye
Mic
>
> Lewis
>
> --
> *Lewis*
>
--
Michele Mostarda
Senior Software Engineer
skype: michele.mostarda
twitter: micmos
mail: me@michelemostarda.com
site : http://www.michelemostarda.com