Mailing-List: contact flex-dev-help@incubator.apache.org; run by ezmlm
Precedence: bulk
Reply-To: flex-dev@incubator.apache.org
Received-SPF: pass (athena.apache.org: domain of haykelbj@gmail.com designates
 209.85.210.47 as permitted sender)
MIME-Version: 1.0
In-Reply-To: <CB627103.9D5F%cframpto@adobe.com>
References: 
 <CAEFz_vvpmjS39=PucMp9RphuPdBdCN4f30DqEAEJ4eMHN3VgiA@mail.gmail.com>
	<CB627103.9D5F%cframpto@adobe.com>
Date: Thu, 16 Feb 2012 15:35:27 +0100
Message-ID: 
 <CAJ16SzA0Yq6jRRfSqcVad6-bavsCAbVnC7BTQ-KqLaCNjnXUsw@mail.gmail.com>
Subject: Re: asdoc comments for flash player and SDK version numbers
From: Haykel BEN JEMIA <haykelbj@gmail.com>
To: flex-dev@incubator.apache.org
Content-Type: multipart/alternative; boundary=e89a8ffba1bb3bdd9004b915bd87

--e89a8ffba1bb3bdd9004b915bd87
Content-Type: text/plain; charset=UTF-8

Personally I never write detailed documentation while developing. I
generally write a short description and the detailed documentation is
either written by someone else or in another documentation pass, which can
be done in other files.

I have suggested stub classes in an earlier e-mail because I think this
could be useful also for IDEs. They would not require the whole source code
for auto-completion, documentation etc.

Haykel


On 16 February 2012 14:41, Carol Frampton <cframpto@adobe.com> wrote:

> I am totally against stripping out the asdoc.  Who do you think writes the
> asdoc?  We do.  It is just as important as the code.  If you strip it out
> it won't be kept current.  It should be part of any code review.
>
> Carol
>
> On 2/16/12 4 :15AM, "Omar Gonzalez" <omarg.developer@gmail.com> wrote:
>
> >>
> >> Perhaps a script to strip out all comments and a way to create patches
> >> ignoring missing comments would be useful?
> >>
> >> Thanks,
> >> Justin
> >
> >
> >I'm not quire sure what you mean. The ideal solution would be to figure
> >out
> >a way to keep comments in such a way that the during development they're
> >not in our files but at release or at patch submission the proper
> >documentation is there.
> >
> >--
> >Omar Gonzalez
> >s9tpepper@apache.org
>
>

--e89a8ffba1bb3bdd9004b915bd87--