[Lazarus] Documentation contribution
Juha Manninen
juha.manninen62 at gmail.com
Fri Feb 10 13:55:41 CET 2012
2012/2/10, Everton Vieira <tonvieira at gmail.com>:
> Would be nice in an open source project to have means to the documentation
> to be developed in community.
>
> I'm freak sure that lot of people knows a lot of examples and cases of use
> that could help a lot, a lot of people. A lot sure, hihi.
>
> The problem is always how to organize that, and in that, i strongly suggest
> some kind of database. Documentation direct in the code is always hard to
> format and hard to keep a sense of unity and integrity. [...]
Everton, maybe you don't know that LCL documentation is not inside the
pascal source code but in separate XML files, which are kind of a
database.
You can contribute for them easily by editing the files and creating a
patch. The difficult part is actually writing a good quality and
consistent documentation.
DoDi's idea for a new XML tag for notes is well justified IMO. You can
write comments and todo-items in pascal source code, why can't you
write them in document (XML) source files?
Juha
More information about the Lazarus
mailing list