[fpc-devel] fpdoc has incomplete type definitions in the documentation output

Graeme Geldenhuys graemeg.lists at gmail.com
Wed Aug 11 09:26:28 CEST 2010


When generating HTML class documentation, the Class definition displayed is
not the same as the actual class definition in the code. The definition in
the HTML docs show:

  TfpgBaseButton = class(TfpgWidget)

when in fact the real code in the .pas unit is:

  TfpgBaseButton = class(TfpgWidget, ICommandHolder)

I mentioned in a 'feature request' that it would be nice if the class
documentation can list the implemented interfaces (something like JavaDoc
does). That would be nice, but even if we can start by including the "real"
class definition in the documentation output, that would be good too.

I found more such problems (not relating to Interfaces too). For example, I
have a record that is marked as 'deprecated' in the pas unit. But the HTML
type definition of that record doesn't show the 'deprecated' keyword.
eg: HTML output.

TRGBTriple = record
  Red: Word;
  Green: Word;
  Blue: Word;
  Alpha: Word;

but the real code in the .pas unit is as follows:

  TRGBTriple = record
    Red: word;
    Green: word;
    Blue: word;
    Alpha: word;
  end deprecated;

Note the HTML output is missing the 'deprecated' keyword. Same as the
missing implemented Interface in my button example. Another example is a
property with the 'platform' modifier. The definition shown in the fpdoc
class documentation doesn't include the 'platform' modifier in the code

Is all this by design, or simply an oversight/bug in the fpdoc program?

  - Graeme -

fpGUI Toolkit - a cross-platform GUI toolkit using Free Pascal

More information about the fpc-devel mailing list