Sign in Join

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

Mailing lists / fpc-devel / 2011-09

FPDoc and inherited methods

12 messages · 6 people · –

Reply by email Subscribe to this list Your subscription

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

Hans-Peter Diettrich

It looks like FPDoc links to an inherited item (method), when only a short description is provided for an overridden method. Is this intended behaviour? (see Controls.TDragControlObject)

The short description is shown e.g. in the class declaration, but the link from there goes to the inherited method. What's required that links go to the overridden method description instead?

Please note that I don't ask for an change of this behaviour, only for a confirmation whether this is reliable behaviour (by design).

DoDi

Reply by email

Hans-Peter Diettrich
to Hans-Peter Diettrich
It looks like FPDoc links to an inherited item (method), when only a short description is provided for an overridden method. Is this intended behaviour? (see Controls.TDragControlObject)

I also have the impression that FPDoc does not (always) overwrite existing HTML files.

DoDi

Reply by email

Hans-Peter Diettrich
to Hans-Peter Diettrich: It looks like FPDoc links to an inherited item (method), when only a short description is…

Thanks for the improvements in the last updates, but...

How do I obtain the latest documentation on FPDoc?

For records with variant parts, no short descriptions are shown for the members in the variant part. Parameters for overloaded methods are already supported, so this extension should not be too hard to implement?

FPDoc now also doesn't have "html" as the default format, requires an explicit format parameter.

The handling of the css file still is cryptic. Even with --css-file given no file is copied. The location seems to have changed to the parent directory, i.e. docs/html?

The messages have changed.
What does it mean, when a dependency(?) could not be resolved? (heritage, link, ???)
When heritage is meant, I'd suggest something like "Ancestor ... of ... not found". At least I like messages starting with a fixed part, indicating the message type, not with an identifier.

What do the "new alias ..." messages mean *to the user*?

DoDi

Reply by email

Michael Van Canneyt
to Hans-Peter Diettrich
Hans-Peter Diettrich wrote
Thanks for the improvements in the last updates, but... How do I obtain the latest documentation on FPDoc?

make fpdoc.pdf in docs.

For records with variant parts, no short descriptions are shown for the members in the variant part. Parameters for overloaded methods are already supported, so this extension should not be too hard to implement?

Well, in that case presumably you can handle it ?

FPDoc now also doesn't have "html" as the default format, requires an explicit format parameter.

This behaviour has not changed recently.

The handling of the css file still is cryptic. Even with --css-file given no file is copied. The location seems to have changed to the parent directory, i.e. docs/html?

This behaviour has not changed recently.

The messages have changed. What does it mean, when a dependency(?) could not be resolved? (heritage, link, ???)

Presumably a class inheritance. Can you post a more clear message ?

None of the messages have changed the last 8 months. I checked this.

You may now get extra messages since you use it more (or better), but not changes.

Show quoted text 5 lines
When heritage is meant, I'd suggest something like "Ancestor ... of ... not found". At least I like messages starting with a fixed part, indicating the message type, not with an identifier. What do the "new alias ..." messages mean *to the user*?

As far as I can tell, they are debug messages.

Michael.

Reply by email

Marco van de Voort
to Michael Van Canneyt

In our previous episode, Michael Van Canneyt said:

Show quoted text 7 lines
> When heritage is meant, I'd suggest something like "Ancestor ... of ... not > found". At least I like messages starting with a fixed part, indicating the > message type, not with an identifier. > > What do the "new alias ..." messages mean *to the user*? As far as I can tell, they are debug messages.

I commented those. Some other alias msgs are still there, but they really indicate problems, while these were mostly to follow flow (or at least only signaled problems after manual analysis of the output).

If you find such errors relating to preoceduretypes, please leave them in. They are in spots that have something to do with the remaining fpdoc crash (when compiling lcl if fpdoc is compiled without -O-)

I use them to see if tracebacks that I get back are the same as the ones I get myself.

Reply by email

Hans-Peter Diettrich
to Michael Van Canneyt: make fpdoc.pdf in docs. Well, in that case presumably you can handle it ? This behaviour…
> How do I obtain the latest documentation on FPDoc? make fpdoc.pdf in docs.

No Latex support here (Win7)

Show quoted text 5 lines
> For records with variant parts, no short descriptions are shown for > the members in the variant part. Parameters for overloaded methods are > already supported, so this extension should not be too hard to implement? Well, in that case presumably you can handle it ?

I'm a user of fpdoc, not a maintainer, have no idea of the internals.

> FPDoc now also doesn't have "html" as the default format, requires an > explicit format parameter. This behaviour has not changed recently.

Well, it's documented as the default, and was working so in some older version. I've fpdoc 2.2.4 in my path by default...

Show quoted text 12 lines
> The handling of the css file still is cryptic. Even with --css-file > given no file is copied. The location seems to have changed to the > parent directory, i.e. docs/html? This behaviour has not changed recently. > > The messages have changed. > What does it mean, when a dependency(?) could not be resolved? > (heritage, link, ???) Presumably a class inheritance. Can you post a more clear message ?

new alias #rtl.System.IInterface (IUnknown)
new alias #rtl.System.IInterface (IUnknown)
new alias #rtl.System.IInterface (IUnknown)
TCustomActionList's dependency TLCLComponent could not be resolved TArrow's dependency TCustomControl could not be resolved TAsyncProcess's dependency TProcessUTF8 could not be resolved ...

> What do the "new alias ..." messages mean *to the user*? As far as I can tell, they are debug messages.

How to turn off?

DoDi

Reply by email

Michael Van Canneyt
to Hans-Peter Diettrich
Hans-Peter Diettrich wrote 7 lines
Michael Van Canneyt schrieb: >> How do I obtain the latest documentation on FPDoc? > > make fpdoc.pdf in docs. No Latex support here (Win7)

Then no more recent docs than the official ones on the website.

Show quoted text 7 lines
>> For records with variant parts, no short descriptions are shown for the >> members in the variant part. Parameters for overloaded methods are already >> supported, so this extension should not be too hard to implement? > > Well, in that case presumably you can handle it ? I'm a user of fpdoc, not a maintainer, have no idea of the internals.

In that case, please do not say things like
'this extension should not be too hard to implement' But please, file a bug report so we won't forget.

Show quoted text 7 lines
>> FPDoc now also doesn't have "html" as the default format, requires an >> explicit format parameter. > > This behaviour has not changed recently. Well, it's documented as the default, and was working so in some older version. I've fpdoc 2.2.4 in my path by default...

2.2.4 ? That is definitely not 'recently' :-)

Show quoted text 20 lines
>> The handling of the css file still is cryptic. Even with --css-file given >> no file is copied. The location seems to have changed to the parent >> directory, i.e. docs/html? > > This behaviour has not changed recently. > >> >> The messages have changed. >> What does it mean, when a dependency(?) could not be resolved? (heritage, >> link, ???) > > Presumably a class inheritance. Can you post a more clear message ? new alias #rtl.System.IInterface (IUnknown) new alias #rtl.System.IInterface (IUnknown) new alias #rtl.System.IInterface (IUnknown) TCustomActionList's dependency TLCLComponent could not be resolved TArrow's dependency TCustomControl could not be resolved TAsyncProcess's dependency TProcessUTF8 could not be resolved ...

It refers to a parent class. I've adapted the message to be more clear.

Show quoted text 5 lines
>> What do the "new alias ..." messages mean *to the user*? > > As far as I can tell, they are debug messages. How to turn off?

Comment out in code. I think Marco took care of it already.

Michael.

Reply by email

Hans-Peter Diettrich
to Michael Van Canneyt
Show quoted text 5 lines
> I'm a user of fpdoc, not a maintainer, have no idea of the internals. In that case, please do not say things like 'this extension should not be too hard to implement' But please, file a bug report so we won't forget.

This whole threads is about bugs and problems with FPDoc, in the hope that most can be fixed without extra bug reports.

Show quoted text 15 lines
>>> The messages have changed. >>> What does it mean, when a dependency(?) could not be resolved? >>> (heritage, link, ???) >> >> Presumably a class inheritance. Can you post a more clear message ? > > new alias #rtl.System.IInterface (IUnknown) > new alias #rtl.System.IInterface (IUnknown) > new alias #rtl.System.IInterface (IUnknown) > TCustomActionList's dependency TLCLComponent could not be resolved > TArrow's dependency TCustomControl could not be resolved > TAsyncProcess's dependency TProcessUTF8 could not be resolved > ... It refers to a parent class. I've adapted the message to be more clear.

Thanks :-)

DoDi

Reply by email

Unknown author
to Hans-Peter Diettrich
Hans-Peter Diettrich wrote 10 lines
Michael Van Canneyt schrieb: >> I'm a user of fpdoc, not a maintainer, have no idea of the internals. > > In that case, please do not say things like > 'this extension should not be too hard to implement' > But please, file a bug report so we won't forget. This whole threads is about bugs and problems with FPDoc, in the hope that most can be fixed without extra bug reports.

If I ask you to add this as a bug report it is because a) I indeed consider it a bug
b) I realize it is not fixable in 10 minutes and hence will not be done anytime soon.

Michael.

Reply by email

Marco van de Voort
to Graeme Geldenhuys

In our previous episode, Graeme Geldenhuys said:

>> No Latex support here (Win7) > Virtual Box is your friend :-) . Even easier, you get LaTeX for Windows too... I think it is called something like MiKTex.

Even better, TeXLive has easy installers nowaday, and that is the TeX distro mostly used on *nix.

I tried and it works if you do one manual at the time, but have to comment some unix shell script in Makefile.4ht which moves the generated files to a directory.

Reply by email