On Thu, 22 Jul 2010 22:35:48 +0200 Bernd <prof7...@googlemail.com> wrote:
> 2010/7/22 Andreas Schneider <ak...@gmx.de>: > > > Many classes and methods are already documented in fpdoc. > > Ok, now I'm looking for these files but it seems It is not so easy to > find them anywhere on the ftp server or the website or sf.net. The fpdoc files for the LCL are in docs/xml/lcl. Most packages put their fpdoc files into a sub directory 'docs'. > I am > using one of the recent snapshots and It would be nice to have a > snapshot of these fpdoc files that belong to the downloaded lazarus > version that i could just unzip into the folder where it belongs or > even better: a .deb or .rpm or a windows installer. The IDE hints read the fpdoc files directly. No need to install anything. But the fpdoc files also contain descriptions, examples, images, links and topics. This information is not yet shown in the hints. You can see the html output of fpdoc when pressing F1 on an identifier. You can install lhelp for an offline help viewer. >[...] > I can not applaud this decision but unfortunately I won't be able to > convince the developers that this is fundamentally wrong. It seems > like too much effort has already gone into this to throw it away now, > altough this would be the wisest decision. IMHO code should be > documented in the code itself. This is what I (and many others) have > found most useful, most portable and most easy to handle. The process > of documenting code (something most programmers seem to find extremely > difficult and hard to do and therefore often don't do it at all) > should not be further *complicated* by forcing the usage of separate > files that must be kept in sync with the code and the usage of a > specialized tool. I hope the fpdoc thing can generate itself from > source comments alone that are already present in the code. > > BTW: The statement somewhere in the fpdoc manual that code becomes > "obfuscated" by properly commenting it is ridiculous! Lazarus supports comments, fpdoc and other formats. If you prefer comments, use comments. If using comments wrong they can easily obfuscate code. And comments are limited. The LCL needs examples, links, graphics, topics and eventually translations. Mattias -- _______________________________________________ Lazarus mailing list Lazarus@lists.lazarus.freepascal.org http://lists.lazarus.freepascal.org/mailman/listinfo/lazarus
