You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@flex.apache.org by Gordon Smith <go...@adobe.com> on 2012/09/12 01:13:58 UTC
Javadoc for Falcon
How shall we make Falcon's Javadoc available?
1. Require developers to build it locally with 'ant javadoc'.
2. Have a build machine which builds it and posts it somewhere.
3. Check it into the Subversion repository somewhere.
- Gordon
AW: Javadoc for Falcon
Posted by "christofer.dutz@c-ware.de" <ch...@c-ware.de>.
Nevertheless it's still good to have good old Google index the Asdoc content ... I think I'm not the only developer that thinks it's quicker to use a search engine in order to find Api documentation than to open it from disk ;-)
-----Ursprüngliche Nachricht-----
Von: Raju Bitter [mailto:r.bitter.mailinglists@googlemail.com]
Gesendet: Mittwoch, 12. September 2012 16:21
An: flex-dev@incubator.apache.org; jeffry@dot-com-it.com
Betreff: Re: Javadoc for Falcon
>> I'd check a zipped version of the docs into Subversion.
> I'm pretty sure that it is an "Apache Way" no no to put binary files
> into the repository if it can be avoided. In this case, I don't
> believe zipping up generated docs is an unavoidable approach.
I think the decision should be based on the fact if there's a binary distribution available. A binary distribution should be packaged with the generated docs, but if there is no binary distribution, people have to get the source code anyway.
- Raju
Re: Javadoc for Falcon
Posted by Raju Bitter <r....@googlemail.com>.
>> I'd check a zipped version of the docs into Subversion.
> I'm pretty sure that it is an "Apache Way" no no to put binary files into
> the repository if it can be avoided. In this case, I don't believe zipping
> up generated docs is an unavoidable approach.
I think the decision should be based on the fact if there's a binary
distribution available. A binary distribution should be packaged with
the generated docs, but if there is no binary distribution, people
have to get the source code anyway.
- Raju
Re: Javadoc for Falcon
Posted by Jeffry Houser <je...@dot-com-it.com>.
On 9/11/2012 7:24 PM, Raju Bitter wrote:
> I'd check a zipped version of the docs into Subversion.
I'm pretty sure that it is an "Apache Way" no no to put binary files
into the repository if it can be avoided. In this case, I don't believe
zipping up generated docs is an unavoidable approach.
--
Jeffry Houser
Technical Entrepreneur
203-379-0773
--
http://www.flextras.com?c=104
UI Flex Components: Tested! Supported! Ready!
--
http://www.theflexshow.com
http://www.jeffryhouser.com
http://www.asktheflexpert.com
--
Part of the DotComIt Brain Trust
Re: Javadoc for Falcon
Posted by Raju Bitter <r....@googlemail.com>.
I'd check a zipped version of the docs into Subversion. Easy to
download, and you don't have a large number of generated files in the
repository. Most people interested in the docs will probably want the
code anyway, I'm not sure the docs need to be posted to a public URL.
- Raju
Re: Javadoc for Falcon
Posted by Jeffry Houser <je...@dot-com-it.com>.
On 9/11/2012 7:13 PM, Gordon Smith wrote:
> How shall we make Falcon's Javadoc available?
>
> 1. Require developers to build it locally with 'ant javadoc'.
> 2. Have a build machine which builds it and posts it somewhere.
> 3. Check it into the Subversion repository somewhere.
>
> - Gordon
I vote 1 and 2.
1 because we should always have the source code available, and having
people able to create the docs is important. If there is a third party
depedency needed to create the JavaDocs from the source, we should
document that somehow.
2. Because I think it is good to have this information available. I
would love to see JavaDoc (and ASDocs) on the Apache Flex site in some
manner.
I have mixed feelings about checking the generated docs into the repo
as part of the Falcon project. I'm not sure if that is a good or bad
idea; but could probably be swayed either way.
--
Jeffry Houser
Technical Entrepreneur
203-379-0773
--
http://www.flextras.com?c=104
UI Flex Components: Tested! Supported! Ready!
--
http://www.theflexshow.com
http://www.jeffryhouser.com
http://www.asktheflexpert.com
--
Part of the DotComIt Brain Trust
Re: Javadoc for Falcon
Posted by Carol Frampton <cf...@adobe.com>.
On 9/11/12 7 :13PM, "Gordon Smith" <go...@adobe.com> wrote:
>How shall we make Falcon's Javadoc available?
>
>1. Require developers to build it locally with 'ant javadoc'.
I believe this choice would be the Apache way.
Carol
>2. Have a build machine which builds it and posts it somewhere.
>3. Check it into the Subversion repository somewhere.
>
>- Gordon
>