How to use FPDOC MAKESKEL to include INC files as well?

[avra]

I used MAKESKEL to generate skelethon XML for FPDOC like this:

Code: [Select]

makeskel --package=syshelpers --input=m:\Lazarus\testing\SysHelpers\syshelpers.pas --output=syshelpers.xmland XML file was created. However, I also need to somehow include 4 *.inc files into the same XML skelethon (if that would be the proper way for my goal of having everything in a single XML). How can I achieve this?

[avra]

Silly me, it seams that inclusion is automatic since all *.inc files are already referenced in the main unit. 

[marcov]

Afaik the input parameter is like a commandline, you can also pass paths there. See manual, excerpt:

This option tells FPDoc what input file should be used. The argument can be just a filename, but can also be a complete compiler command-line with options that concern the scanning of the Pascal source: defines, include files, syntax options, as they would be specified to the Free Pascal compiler when compiling the file. If a complete command is used, then it should be enclosed in single or double quotes, so the shell will not break them in parts.

[avra]

I am back to documenting syshelpers, and I am using makeskel to create xml doc template like this:

makeskel --package=rtl --input=c:\Prg\Lazarus\TrunkAll\fpcsrc\packages\rtl-objpas\src\inc\syshelpers.pp --output=syshelpers.xml

It is not quite clear to me if I should use --package=rtl or --package=syshelpers in the above example. Please advise.

[marcov]

See package as a CHM. If it goes into the same CHM, it has the same package. If not, it is a different package.

I'd simply choose some unique package name, so it is simple to change with a substitution later, if needed.

[avra]

See package as a CHM. If it goes into the same CHM, it has the same package. If not, it is a different package.

When I open RTL CHM I see that it holds sysutils unit among others. I think that syshelpers unit should be there as well. In such a case I should use --package=rtl, right?

[marcov]

I checked and it is in rtl-objpas, so yes, RTL.

[Thaddy]

Same conclusion as Marco: Checked.

[avra]

Thanks, it is clear now