Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Back-comment doesn't work after a variable of that has a "procedure ... of object" type #92

Open
michaliskambi opened this issue Apr 20, 2020 · 3 comments

Comments

@michaliskambi
Copy link
Collaborator

Submitted on https://sourceforge.net/p/pasdoc/bugs/92/ .

Original description:


If you place a pasdoc comment like this:

{Placeholder for pointer to procedure in main thread.}
readInfo : procedure(Info : TEventMessage) of object;

it will work. However, the alternativ with backpointer like:

readInfo : procedure(Info : TEventMessage) of object; //< Placeholder for pointer to procedure in main thread.}

will not. Without the "of object" spesification, it does work.

Regards Bent Vangli


Michalis can reproduce it indeed, with this testcase:

unit ok_back_comment_procvar;
interface
var
  readInfo : procedure(Info : TEventMessage) of object; //< Something something.
implementation
end.

The output is:

$ bin/pasdoc /tmp/ok_back_comment_procvar.pas 
PasDoc 0.15.0 [2018-02-08|FPC 3.0.4|Linux|64]
Documentation generator for Pascal source

This is free software; see the source for copying conditions.  There is NO
warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

Info[1]:    Starting Source File Parsing ...
Info[2]:    Now parsing file /tmp/ok_back_comment_procvar.pas...
Warning[1]: /tmp/ok_back_comment_procvar.pas(4): This is a back-comment (comment starting with "<") but there is no item declared right before it: " Something something."
Info[2]:    ... 1 Source File(s) parsed
Info[2]:    Creating links ...
Info[2]:    ...  links created
Info[2]:    Expanding descriptions (pass 1) ...
Info[2]:    Expanding descriptions (pass 2) ...
Info[2]:    ... Descriptions expanded
Info[2]:    Writing Docs for unit "ok_back_comment_procvar"
Info[1]:    Done

.. and readInfo indeed has no documentation.

@Fr0sT-Brutal
Copy link
Collaborator

How about recent version?

@michaliskambi
Copy link
Collaborator Author

I reproduced this with latest PasDoc code from GitHub, today.

( Yeah, the version line with PasDoc 0.15.0 [2018-02-08... is misleading, that's just version number and date hardcoded, corresponding to the last release. )

@Fr0sT-Brutal
Copy link
Collaborator

Ok, the date has cheated me :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants