Am Dienstag, den 04.07.2006, 18:35 +0200 schrieb Jerome Glisse:
> On 7/4/06, Tilman Sauerbeck <[EMAIL PROTECTED]> wrote:
> > Jerome Glisse [2006-07-03 23:49]:
> > > For indenting rules i personnaly use the linux kernel ones,
> > > iirc this was the original indenting choosed by Nicolai.
> > > Anyway, we can use another if people prefer another one
> > > (as long as the indenting you propose is not severly broken).
> >
> > Shouldn't we stick to the Mesa indentation rules?
> 
> http://www.mesa3d.org/devinfo.html
> 
> You could find rules for Mesa there, duno if there are the actual
> one :) If no one object i will go with this one.
> 
> > > For function name i think that r300DoSomething is for
> > > function called by mesa and r300_do_otherthings is for
> > > internal driver function at leat this is my guess from looking
> > > at i915 driver :)
> >
> > I'd prefer not to mix up CamelCase and snake_case. Do you think the
> > benefit it provides is good enough to make up for the inconsistency?
> 
> I think this is good enough, thus you can easily spot which function
> are called by mesa and which one could only be called inside the
> driver. There is little explanation for that here :
> http://www.mesa3d.org/devinfo.html
> 
> Btw what about doxygen comment ? Might help people looking at
> the driver and might help refreshing memory when you get back
> on old code :)

I personally dislike using doxygen. It bloats the code without having a
real benefint. Most developers don't comment oder don't comment very
well. Without a "Guide on documenting code" it's pretty useless from my
experience. And I think especially in hardware development (when you're
happy when you are done ;-) ) the "special tricks necessary to get it
working" will in best cases be found in a normal comment and not the
Doxygen one. But I like doxygen to create call graphs. This is pretty
helpfull whe I try to trace function calls to understand what is
happening (like pressing F3 in Eclipse when developing Java).

But I really recommend documenting the code in whatever way is the
best :-)


Using Tomcat but need to do more? Need to support web services, security?
Get stuff done quickly with pre-integrated technology to make your job easier
Download IBM WebSphere Application Server v.1.0.1 based on Apache Geronimo
http://sel.as-us.falkag.net/sel?cmd=lnk&kid=120709&bid=263057&dat=121642
--
_______________________________________________
Dri-devel mailing list
Dri-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/dri-devel

Reply via email to