Sign in Join

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

Mailing lists / lazarus / 2009-10

TAChart documentation

7 messages · 4 people ·

Reply by email Subscribe to this list Your subscription

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

Alexander Klenin

I want to start documenting TAChart components.
How should I proceed? Where should I put it?
In the light of recent help discussion, what tool/format should I use -- lazde, lhelp, that new tool Greame is writing?

Alexander S. Klenin

Reply by email

Vincent Snijders
to Alexander Klenin
Alexander Klenin wrote 5 lines
I want to start documenting TAChart components. How should I proceed? Where should I put it? In the light of recent help discussion, what tool/format should I use -- lazde, lhelp, that new tool Greame is writing?

You should use fpdoc format. You can edit that lazde or with the internal fpdoc editor (or any xml or text editor).

fpdoc can generate html for online help, chm for lhelp and other chm viewers and in the future Graemes IPF format for using Graemes help viewer.

Vincent

Reply by email

Alexander Klenin
to Vincent Snijders
Vincent Snijders wrote 13 lines
Alexander Klenin schreef: > > I want to start documenting TAChart components. > How should I proceed? Where should I put it? > In the light of recent help discussion, what tool/format should I use -- > lazde, lhelp, that new tool Greame is writing? > You should use fpdoc format. You can edit that lazde or with the internal fpdoc editor (or any xml or text editor). fpdoc can generate html for online help, chm for lhelp and other chm viewers and in the future Graemes IPF format for using Graemes help viewer.

Ok, where should I put it?
How many files should I create -- single file, file per unit, file per class?

Alexander S. Klenin

Reply by email

Vincent Snijders
to Alexander Klenin
Alexander Klenin wrote 15 lines
On Fri, Oct 9, 2009 at 03:47, Vincent Snijders wrote: > Alexander Klenin schreef: >> I want to start documenting TAChart components. >> How should I proceed? Where should I put it? >> In the light of recent help discussion, what tool/format should I use -- >> lazde, lhelp, that new tool Greame is writing? >> > You should use fpdoc format. You can edit that lazde or with the internal > fpdoc editor (or any xml or text editor). > > fpdoc can generate html for online help, chm for lhelp and other chm viewers > and in the future Graemes IPF format for using Graemes help viewer. Ok, where should I put it?

In a subdirectory under lazarus/components/tachart, for example doc or fpdoc. I don't know if we already have fpdoc xml files for packages in or tree. Don't forget to enter the directory in Package Editor -> Options -> IDE integration -> FPDoc files path.

How many files should I create -- single file, file per unit, file per class?

You can use the makeskel tool (distributed with fpc) to create a new fpdoc xml file, one for each unit.

Vincent

Reply by email

Vincent Snijders
to Vincent Snijders
Vincent Snijders wrote 6 lines
In a subdirectory under lazarus/components/tachart, for example doc or fpdoc. I don't know if we already have fpdoc xml files for packages in or tree. Don't forget to enter the directory in Package Editor -> Options -> IDE integration -> FPDoc files path.

rtticontrols uses the fpdoc subdirectory.

Some hints on using fpdoc can be found at:
http://svn.freepascal.org/svn/lazarus/trunk/docs/xml/README.txt

Vincent

Reply by email

Mattias Gaertner
to Vincent Snijders: In a subdirectory under lazarus/components/tachart, for example doc or fpdoc. I don't…
Show quoted text 22 lines
Alexander Klenin schreef: > On Fri, Oct 9, 2009 at 03:47, Vincent Snijders > wrote: >> Alexander Klenin schreef: >>> I want to start documenting TAChart components. >>> How should I proceed? Where should I put it? >>> In the light of recent help discussion, what tool/format should I >>> use -- lazde, lhelp, that new tool Greame is writing? >>> >> You should use fpdoc format. You can edit that lazde or with the >> internal fpdoc editor (or any xml or text editor). >> >> fpdoc can generate html for online help, chm for lhelp and other >> chm viewers and in the future Graemes IPF format for using Graemes >> help viewer. > > Ok, where should I put it? In a subdirectory under lazarus/components/tachart, for example doc or fpdoc. I don't know if we already have fpdoc xml files for packages in or tree. Don't forget to enter the directory in Package Editor -> Options -> IDE integration -> FPDoc files path.

All this is done automatically.
Just place caret on an identifier, IDE menu View / FPDoc editor, click on create item. The IDE will ask if it should create the sub directory, click ok.

Show quoted text 6 lines
> How many files should I create -- single file, file per unit, file > per class? > You can use the makeskel tool (distributed with fpc) to create a new fpdoc xml file, one for each unit.

The fpdoc editor does that automatically.

Mattias

Reply by email

Graeme Geldenhuys
to Vincent Snijders: You should use fpdoc format. You can edit that lazde or with the internal fpdoc editor…

2009/10/8 Vincent Snijders :

You should use fpdoc format. You can edit that lazde or with the internal fpdoc editor (or any xml or text editor).

Vincent is correct. For any class documentation, fpdoc is the preferred format (in FPC circles). The internal FPDoc editor inside Lazarus IDE is a nice quick way of editing such docs. You can look at the code and add comments as you work through the code. Very handy!

fpdoc can generate html for online help, chm for lhelp and other chm viewers and in the future Graemes IPF format for using Graemes help viewer.

@Vincent
fpdoc can already generate IPF output - it just needs some beautifying and minor tweaks - which I am working on.

Regards, - Graeme - _______________________________________________ fpGUI - a cross-platform Free Pascal GUI toolkit http://opensoft.homeip.net/fpgui/

Reply by email