Sign in Join

Live chat for Free Pascal, Lazarus, Delphi and every Pascal programmer.

Mailing lists / lazarus / 2003-11

Documentation?

7 messages · 3 people ·

Reply by email Subscribe to this list Your subscription

Read-only archive. Use j and k to move between messages.

Martin Larsson

What's the state of the documentation?

I looked at the 'Documentation' link on lazarus.freepascal.org. It claimed to be generated nightly. But all the documents I pulled (form anonymous) CVS was several months old. Is any work being done there?
There was some reference to using fpDoc instead of the current (?) pasdoc. Is that still the plan? I tried finding fpDoc, but fpDoc.freepascal.org apparently doesn't exist anymore.

The reason I'm asking is that I'm interested in contributing to the project. Even though I've been programming Delphi since v. 1, and Turbo Pascal since 3.0, my Linux and FPC skills are somewhat missing. So I thought getting to know the class library was a good way to get started. But ... how? :*)

M.

Martin Larsson
Mattias Gaertner
to Martin Larsson
Show quoted text 11 lines
On Tue, 2003-11-25 at 13:08, Mattias Gaertner wrote: > On 25 Nov 2003 10:48:32 +0100 Martin Larsson wrote: > > > There was some reference to using fpDoc instead of the current (?) > > pasdoc. Is that still the plan? > > Yes. Ok. Are there any plans for linking to this from within the IDE? Or extracting the info here and combine with a helpsystem of some sort? (so many questions...)

Yes. The IDE will remote control a helpbrowser, that will show the fpdoc content and provide search features.

Show quoted text 8 lines
> Add docs to the is world > writable. If you think, that a category is missing, just mail. Hm. Ok. I was thinking of writing something for the component library. Seems there is only one unit documented? But that also seems to be in the non-wiki part of the site (under FPC-documentation). I'm sorry I feel a bit lost here...

The FPC part is from the FreePascal Documentation. Only the lazarus part is wiki.

The units should be documented in the fpDoc format.

Mattias

Martin Larsson
to Martin Larsson: What's the state of the documentation? I looked at the 'Documentation' link on…
Mattias Gaertner wrote 6 lines
On 25 Nov 2003 10:48:32 +0100 Martin Larsson wrote: > There was some reference to using fpDoc instead of the current (?) > pasdoc. Is that still the plan? Yes.

Ok. Are there any plans for linking to this from within the IDE? Or extracting the info here and combine with a helpsystem of some sort? (so many questions...)

Add docs to the is world writable. If you think, that a category is missing, just mail.

Hm. Ok. I was thinking of writing something for the component library. Seems there is only one unit documented? But that also seems to be in the non-wiki part of the site (under FPC-documentation).

I'm sorry I feel a bit lost here...

M.

Martin Larsson
Justin P Arundell
to Martin Larsson: What's the state of the documentation? I looked at the 'Documentation' link on…

On Tue, 25 Nov 2003 20:48, Martin Larsson wrote:
...

Show quoted text 5 lines
The reason I'm asking is that I'm interested in contributing to the project. ... ... ... So I thought getting to know the class library was a good way to get started. But ... how? :*)

...

Me too.

I had a look at things to be done and they all seemed a bit beyond me, for now.
Great Project!

Justin

Mattias Gaertner
to Martin Larsson: What's the state of the documentation? I looked at the 'Documentation' link on…
Show quoted text 6 lines
What's the state of the documentation? I looked at the 'Documentation' link on lazarus.freepascal.org. It claimed to be generated nightly. But all the documents I pulled (form anonymous) CVS was several months old. Is any work being done there?

No.
There are some docs at http://lazarus-ccr.sourceforge.net/

There was some reference to using fpDoc instead of the current (?) pasdoc. Is that still the plan?

Yes.

I tried finding fpDoc, but fpDoc.freepascal.org apparently doesn't exist anymore.

It is part of fpc.

Show quoted text 5 lines
The reason I'm asking is that I'm interested in contributing to the project. Even though I've been programming Delphi since v. 1, and Turbo Pascal since 3.0, my Linux and FPC skills are somewhat missing. So I thought getting to know the class library was a good way to get started. But ... how? :*)

Add docs to the is world writable.
If you think, that a category is missing, just mail.

Mattias

Mattias Gaertner
to Martin Larsson: What's the state of the documentation? I looked at the 'Documentation' link on…
Show quoted text 5 lines
On Tue, 2003-11-25 at 15:02, Mattias Gaertner wrote: > The FPC part is from the FreePascal Documentation. > Only the lazarus part is wiki. Ok. Anything in particular you'd like to be worked on first?

A Tutorial for the IDE and/or a LCL Application would be nice.

Mattias

Show quoted text 12 lines
> The units should be documented in the fpDoc format. Thanks. I'll start looking and learning and writing... :*) -- Martin Larsson _________________________________________________________________ To unsubscribe: mail with "unsubscribe" as the Subject archives at http://www.lazarus.freepascal.org/mailarchives