Sign in Join

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

Mailing lists / fpc-devel / 2012-02

Problem documenting source code

3 messages · 2 people ·

Reply by email Subscribe to this list Your subscription

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

Hans-Peter Diettrich

After adding documentation for some items in the FPDoc Editor, I have problems running MakeSkel or FPDoc. Both report errors in the input file, which seem to be related to wrong or missing compiler options for that file.

How can a documentation writer determine the required compiler options, so that the fpdoc tools can be made work?

In former times[tm] I used "make all -n" in the source directory, to make the compiler options visible. But this approach fails now, the fpmake commandlines are not informative enough for that purpose.

It may be a bad example (work in progress?), but I couldn't figure out the required compiler options for e.g. fcl-process/pipesipc.pp, in an attempt to create the skeletons for the fcl-process package.

DoDi

Reply by email

Unknown author
to Hans-Peter Diettrich
Hans-Peter Diettrich wrote 15 lines
After adding documentation for some items in the FPDoc Editor, I have problems running MakeSkel or FPDoc. Both report errors in the input file, which seem to be related to wrong or missing compiler options for that file. How can a documentation writer determine the required compiler options, so that the fpdoc tools can be made work? In former times[tm] I used "make all -n" in the source directory, to make the compiler options visible. But this approach fails now, the fpmake commandlines are not informative enough for that purpose. It may be a bad example (work in progress?), but I couldn't figure out the required compiler options for e.g. fcl-process/pipesipc.pp, in an attempt to create the skeletons for the fcl-process package.

Why would you want to do that ? These units are fully documented ?

Michael.

Reply by email

Hans-Peter Diettrich
to Unknown author
Show quoted text 5 lines
> It may be a bad example (work in progress?), but I couldn't figure out > the required compiler options for e.g. fcl-process/pipesipc.pp, in an > attempt to create the skeletons for the fcl-process package. Why would you want to do that ?

I simply wanted to generate the skeletons for some FCL packages, based on --input-dir. The mentioned problems can occur with every source file.

These units are fully documented ?

In which version?

DoDi

Reply by email