On Wed, Jul 28, 2010 at 11:46 PM, Gustavo Sverzut Barbieri <barbi...@profusion.mobi> wrote: > On Wed, Jul 28, 2010 at 10:56 PM, Michael Blumenkrantz > <m...@zentific.com> wrote: >> As many of you are aware, much of our documentation ranges from being >> somewhat poor to nonexistent. If we are seriously considering any sort >> of release in the near future, as we seem to be gearing up for with >> things like official code formatting, we need to fix this. >> >> I propose that as of now, patches implementing new EAPI functions which >> are not accompanied by appropriate doxygen docs be rejected until the >> docs have been written. This will cut down on the work for people like >> me, who have been actively trying to fill in the gaps. >> >> I cannot be everywhere to babysit all commits and write READABLE docs >> for them, nor do I want to. > [...] > > Excellent mail Michael! > > To better define what is a READABLE (and useful) documentation, please > document the assumptions such as pre and post conditions: > > - is it a pointer? can it be NULL? what is the effect of NULL? > what's the effect of non-NULL? (let's save some crashes!)
If pointer can not be null, don't forget to mark function definition with EINA_ARG_NONNULL(arg_number). Doing so, if user explicitly passed null, a warning will be emitted. Lucas De Marchi ------------------------------------------------------------------------------ The Palm PDK Hot Apps Program offers developers who use the Plug-In Development Kit to bring their C/C++ apps to Palm for a share of $1 Million in cash or HP Products. Visit us here for more details: http://p.sf.net/sfu/dev2dev-palm _______________________________________________ enlightenment-devel mailing list enlightenment-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/enlightenment-devel
