[Lazarus] Missing Documentation

Mattias Gaertner nc-gaertnma at netcologne.de
Wed Feb 29 13:00:08 CET 2012


Sven Barth <pascaldragon at googlemail.com> hat am 29. Februar 2012 um 12:08
geschrieben:

> Am 29.02.2012 11:33, schrieb Michael Schnell:
> > On 02/29/2012 11:26 AM, Mattias Gaertner wrote:
> >> The wiki is frequently edited by many people and already contains more
> >> than 2500 pages. It makes no sense to shut it down.
> >
> > But if there is no way to keep it in sync with the FPDoc files, how is
> > the future of either considered to be ?
>
> FPDoc <> Wiki


There is no big difference between a link from one fpdoc file to another
(e.g. LCL to RTL) and between a fpdoc element and a wiki page. If one of
them changes you have to update references. Sometimes you have to update
references even though target and source itself have not changed, e.g.
something new has popped up.
Of course for a few special cases support tools can be written, but in
general it needs manual work.
Documentation is not type safe like Pascal.



>
> FPDoc is about documentation of the source code, documentation of the
> LCL, etc.
>
> The Wiki is used for documenting e.g. the usage of the IDE. You can't do
> this using FPDoc.


Well, at least not that comfortable.

Mattias
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.lazarus-ide.org/pipermail/lazarus/attachments/20120229/0d504de4/attachment-0003.html>


More information about the Lazarus mailing list