Sign in Join

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

Mailing lists / fpc-pascal / 2016-10

Does fpdoc sets a particular define ?

5 messages · 2 people · –

Reply by email Subscribe to this list Your subscription

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

Yann Mérignac

Hi all,

While generating documentation for one of my projects I ran into a bug in fpdoc. It crashes on declarations like this one:

-------
type
TObjectBlob = class(specialize TGenBlob<TObject>)
...

  end;

-------

I reported the bug here: http://bugs.freepascal.org/view.php?id=30810

Now, I am looking for a workaround. I know that something like this can work both with FPC and FPDoc:

-------
type
{$ifdef FPDOC}
  TIntermediate = specialize TGenBlob<TObject>;
  TObjectBlob = class(TIntermediate)
{$else}
  TObjectBlob = class(specialize TGenBlob<TObject>)
{$endif}
    function ToString : String; override;
  end;
-------

Is there a way to tell FPDoc to parse only the first part of $ifdef ?

I have tried "fpdoc --input='-dFPDOC' --project=fpdocprj.xml --format=html" but it does not work.

Thanks.

Michael Van Canneyt
to Yann Mérignac
Yann Mérignac wrote 33 lines
Hi all, While generating documentation for one of my projects I ran into a bug in fpdoc. It crashes on declarations like this one: ------- type TObjectBlob = class(specialize TGenBlob<TObject>) ... end; ------- I reported the bug here: http://bugs.freepascal.org/view.php?id=30810 Now, I am looking for a workaround. I know that something like this can work both with FPC and FPDoc: ------- type {$ifdef FPDOC} TIntermediate = specialize TGenBlob<TObject>; TObjectBlob = class(TIntermediate) {$else} TObjectBlob = class(specialize TGenBlob<TObject>) {$endif} function ToString : String; override; end; ------- Is there a way to tell FPDoc to parse only the first part of $ifdef ? I have tried "fpdoc --input='-dFPDOC' --project=fpdocprj.xml --format=html" but it does not work.

It should work in trunk.

Michael.

Yann Mérignac
to Michael Van Canneyt

Thanks ! I'll try to build FPDoc from trunk and test.

2016-10-28 12:11 GMT+02:00 Michael Van Canneyt :

Show quoted text 47 lines
On Fri, 28 Oct 2016, Yann Mérignac wrote: Hi all, > > While generating documentation for one of my projects I ran into a bug in > fpdoc. It crashes on declarations like this one: > > ------- > type > TObjectBlob = class(specialize TGenBlob<TObject>) > ... > end; > ------- > > I reported the bug here: http://bugs.freepascal.org/view.php?id=30810 > > Now, I am looking for a workaround. I know that something like this can > work both with FPC and FPDoc: > > ------- > type > {$ifdef FPDOC} > TIntermediate = specialize TGenBlob<TObject>; > TObjectBlob = class(TIntermediate) > {$else} > TObjectBlob = class(specialize TGenBlob<TObject>) > {$endif} > function ToString : String; override; > end; > ------- > > Is there a way to tell FPDoc to parse only the first part of $ifdef ? > > I have tried "fpdoc --input='-dFPDOC' --project=fpdocprj.xml > --format=html" > but it does not work. > It should work in trunk. Michael. _______________________________________________ fpc-pascal maillist - http://lists.freepascal.org/cgi-bin/mailman/listinfo/fpc-pascal
Yann Mérignac
to Yann Mérignac

I just tried with the trunk version and it works. Thank you.

Can anyone mark the bug report as resolved? (
http://bugs.freepascal.org/view.php?id=30810)

2016-10-28 12:22 GMT+02:00 Yann Mérignac :

Show quoted text 53 lines
Thanks ! I'll try to build FPDoc from trunk and test. 2016-10-28 12:11 GMT+02:00 Michael Van Canneyt : > > > On Fri, 28 Oct 2016, Yann Mérignac wrote: > > Hi all, >> >> While generating documentation for one of my projects I ran into a bug in >> fpdoc. It crashes on declarations like this one: >> >> ------- >> type >> TObjectBlob = class(specialize TGenBlob<TObject>) >> ... >> end; >> ------- >> >> I reported the bug here: http://bugs.freepascal.org/view.php?id=30810 >> >> Now, I am looking for a workaround. I know that something like this can >> work both with FPC and FPDoc: >> >> ------- >> type >> {$ifdef FPDOC} >> TIntermediate = specialize TGenBlob<TObject>; >> TObjectBlob = class(TIntermediate) >> {$else} >> TObjectBlob = class(specialize TGenBlob<TObject>) >> {$endif} >> function ToString : String; override; >> end; >> ------- >> >> Is there a way to tell FPDoc to parse only the first part of $ifdef ? >> >> I have tried "fpdoc --input='-dFPDOC' --project=fpdocprj.xml >> --format=html" >> but it does not work. >> > > It should work in trunk. > > Michael. > _______________________________________________ > fpc-pascal maillist - > http://lists.freepascal.org/cgi-bin/mailman/listinfo/fpc-pascal >