[Qgis-developer] VERY important discussion re QGIS coding standards

[Matthias Kuhn]

Hi

On 10/06/2016 01:05 AM, Nyall Dawson wrote:

> Do you mean #1 here?
>
https://github.com/qgis/QGIS/commit/b642c3ff5ede2cae88d30f881f7ae7c99e1bfccc#diff-aaa596c71ada12dd18c410856a8f4f77R64
> would lead me to think you prefer that style?

Yes, right,
I prefer the one with more "air"

 /**
  * my awesome function
  * does something cool
  */

On 10/06/2016 09:42 AM, Martin Dobias wrote:

> 
> I am very much in favor of not having the @param tags in the docs...
> in most of the cases the meaning of parameters is very obvious, for
> the less obvious ones I would mention them in the method documentation
> and explain them in further detail... just like in Qt docs, which
> seems to work pretty well. Python docs also do not come with a table
> of parameters, they rather explain those in text.

While working today I realized, that I really appreciate this free-form
approach.
+1

Matthias