Again I found almost all of my notes removed from the LCL documentation. If this is how my work is honored, I see no reason why I should spend any more time with contributing to the Lazarus documentation :-(

When somebody is not happy with notes about wrong or missing documentation in the final docs, a feature (tag?) should be added to FPDoc, allowing for editor notes and to show or hide these in the final docs.

DoDi

Hi DoDi,

Hans-Peter Diettrich wrote

Again I found almost all of my notes removed from the LCL documentation. If this is how my work is honored, I see no reason why I should spend any more time with contributing to the Lazarus documentation :-(

I believe you posted this to the wrong mailing list. You talk about LCL docs, but this was read in the fpc-devel mailing list. My reply will go to both mailing lists.

When somebody is not happy with notes about wrong or missing documentation in the final docs, a feature (tag?) should be added to FPDoc, allowing for editor notes and to show or hide these in the final docs.

Just a suggestion... Can't you use the XML comment tag eg: < !-- aoeu -- > (spaces added so as not to screw with HTML email clients)

Though, I don't believe Lazarus's FPDoc Editor will show you those. Maybe that could be another FPDoc Editor feature request.

Hans-Peter Diettrich hat am 10. Februar 2012 um
12:32 geschrieben:

Again I found almost all of my notes removed from the LCL documentation. If this is how my work is honored, I see no reason why I should spend any more time with contributing to the Lazarus documentation :-(

Have you looked into the svn log? Maybe there is a reason. If not, then ask the person.

Mattias

*A general note: *

I am very happy to see these discussions here.

Lazarus is getting a level of maturity and public visibility that ask for decent documentation at least as much as for code improvement.

Regarding the complexity of the topic (help is necessary for for the help viewer itself (how to use), the help content itself (makeup, how to upgrade), the language, the compiler, the IDE, the LCL, the RTL, installable extensions, 3rd party extensions ...), it is most important to provide the best possible tool for help viewing. Here the ability to find the information needed (be it the most basic stuff or the most sophisticated and seldom used feature) is the most important issue. (IMHO this is one of the greatest advantages of Delphi.)

Regarding that help writing is not exactly fun, the best possible tools need to be provided for supporting the help writers.

Obviously we are on a rather good way right now :)

Thanks to all contributors !

-Michael