Sign in Join

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

Mailing lists / lazarus / 2011-04

setting fpdoc package name from lazarus

3 messages · 2 people ·

Reply by email Subscribe to this list Your subscription

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

Marc Santhoff

Hi,

I'm new to using fpdoc, so please be patient. ;)

The problem is that the description files created in lazarus' fpdoc window are not put into the package documentation because they get the package name set to the same name as the project (me thinks).

Scenario is as follows:

I'm developing some basic library code inside lazarus. This will later form a package.

This library code is embedded into a testing project having a simple GUI for quickly testing whatever is necessary.

How can I handle this case, the package name is or will be different from the runnable project name?

OK, while developing I can run fpdoc using the project name and it works. Do I have to use sed/awk for changing the name afterwards or is there a more "integrated" way of doing this? If the name is changed and more testing or development has to be done the names all have to be changed back again ...

TIA,
Marc

Marc Santhoff

Reply by email

Hans-Peter Diettrich
to Marc Santhoff
How can I handle this case, the package name is or will be different from the runnable project name?

I often create a dummy package and add the units to it. That seems to be sufficient for the docfile creation, and the directory can be added to the FPDoc pathes manually. This way my docs are always found, even if the current project doesn't require the dummy package.

Show quoted text 5 lines
OK, while developing I can run fpdoc using the project name and it works. Do I have to use sed/awk for changing the name afterwards or is there a more "integrated" way of doing this? If the name is changed and more testing or development has to be done the names all have to be changed back again ...

I'm not sure about the usage/requirements of project or package names. You can find out yourself what happens when you save the project with a different name...

DoDi

Reply by email

Marc Santhoff
to Hans-Peter Diettrich
Hans-Peter Diettrich wrote 9 lines
Marc Santhoff schrieb: > How can I handle this case, the package name is or will be different > from the runnable project name? I often create a dummy package and add the units to it. That seems to be sufficient for the docfile creation, and the directory can be added to the FPDoc pathes manually. This way my docs are always found, even if the current project doesn't require the dummy package.

I expected this usage to be pretty nromal, fine.

Show quoted text 9 lines
> OK, while developing I can run fpdoc using the project name and it > works. Do I have to use sed/awk for changing the name afterwards or is > there a more "integrated" way of doing this? If the name is changed and > more testing or development has to be done the names all have to be > changed back again ... I'm not sure about the usage/requirements of project or package names. You can find out yourself what happens when you save the project with a different name...

As said, fpdoc decides by the project name which descriptions to include. If the name differs nothing is included.

But the solution seems to be naming the test project the same as the target package, I'll try that and see if there are name clashes.

Thanks,
Marc

Marc Santhoff

Reply by email