[Qgis-developer] Changes in API documentation?

[Leyan]

On 11/03/2014 07:40 PM, Martin Dobias wrote:
> Hi Luigi
>
> On Mon, Nov 3, 2014 at 5:06 PM, Luigi Pirelli <luipir at gmail.com> wrote:
>> added a comment to the commit:
>>
>> I prefer old style documentation that help me to enter directly in the
>> code to understand how it works.
>>
>> ok, I can create my own documentation, but I generally I find it more
>> useful having it online
> The rationale was that users of the documentation should not need to
> read the code of individual functions. If they do, then the
> documentation is simply not good enough. Many other projects we use
> (like Qt, GDAL, GEOS) do not include that either. Those links simply
> make the documentation more bloated. Another reason is that if someone
> needs to browse the code, any IDE with c++ support is 10x more
> efficient for that.
>
> Cheers
> Martin
> _______________________________________________
> Qgis-developer mailing list
> Qgis-developer at lists.osgeo.org
> http://lists.osgeo.org/mailman/listinfo/qgis-developer
>
>
Well, yes, the documentation is not good enough, but I don't think it is 
a good reason to remove a useful link. I found it quite useful, I used 
it mainly in my job where I did not have admin rights to install a C++ 
IDE or any external software. It was quite handy to have the code easily 
available when the documentation was incomplete or outdated.

Regards,

Leyan