On Wed, Aug 01, 2012 at 05:17:48PM +0900, Alex Courbot wrote: > On Wed 01 Aug 2012 05:04:53 PM JST, Thierry Reding wrote: > >* PGP Signed by an unknown key > > > >On Wed, Aug 01, 2012 at 04:37:09PM +0900, Alexandre Courbot wrote: > >>+/** > >>+ * devm_pwm_get() - Resource managed pwm_get() > > > >This is missing parameter descriptions here. > > This is because the documentation for this function just refers to > pwm_get(), and the parameters are the same. I think it's better to > avoid duplicating documentation as much as possible as this makes > two maintenance points instead of one.
devm_pwm_get() and devm_pwm_put() aren't very likely to change. The problem is that they are public APIs and people could be running kerneldoc over the files to have documentation generated and the parameters would be missing in this case. We really don't have a lot of these public functions, but those that are should be properly documented. Thierry
pgpPEvNas4rFX.pgp
Description: PGP signature
