harmony-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Egor Pasko <egor.pa...@gmail.com>
Subject Re: [doc] What should be improved in DRLVM Doxygen documentation?
Date Tue, 07 Nov 2006 15:17:45 GMT
On the 0x21A day of Apache Harmony Mikhail Fursov wrote:
> On 07 Nov 2006 19:08:35 +0600, Egor Pasko <egor.pasko@gmail.com> wrote:
> >
> >
> > > Another problem: anyone who changes a document behaviour must update
> > > comments too :(
> >
> > excuse me, what is "document behaviour"? :)
> >
> 
> Read it as 'method/function behaviour'.  I mean if you have good comments in
> file you can't submit a patch with code refactoring without update in
> comments. Does it become a new requirement?

So, if someone changes semantic of an interface fuction, s/he should
document the new semantics. I think, it is a good policy.

> IMO we should start to collect metrics and add comments for intercomponent
> interfaces only (vm/include/*).

OK. But no one can stop us to document other parts occasionally.

Do we feel that it is time to set responsibilities on documenting
vm/include/* ?

-- 
Egor Pasko


Mime
View raw message