[Lazarus] Documentation of Lazarus internals

[Mattias Gaertner]

On Fri, 13 Nov 2009 02:19:35 +0200
Juha Manninen <juha.manninen at phnet.fi> wrote:

> Hi,
> 
> I am trying to learn how Lazarus works.
> Is there any source code documentation that is more detailed than the
> rather abstract level wiki pages but less detailed than the source
> code itself? Like class diagrams? Other UML style diagrams? Source
> code comments? FPDoc XML files? Anything?
> 
> For example Codetools seems to be a complicated piece of SW which I
> would like to understand. I only found a brief page:
>   http://wiki.lazarus.freepascal.org/Codetools
> 
> and then I find:
>   lazarus/docs/LazarusIDEInternals.pdf
> 
> which don't really help much.

There are examples in components/codetools/examples.

 
> It would be nice to look at a class diagram, then a use case diagram
> and then maybe a sequence diagram to get an idea of how it works and
> which class does what. 

Can you suggest tools to create them?


> Then read the class and method level documents
> made with FPDoc. And then finally read source code when the big
> picture is clear.
> 
> If there is no such documentation ... well, then I must say that my
> own programs are well documented after all. I thought I had a problem
> with poor documentation.

What do you want to do? Maybe I can start the documentation with that.

Mattias