Is the paszlib package documented in the fpcdocs?

If not, I'm considering using it as my first try at documenting a unit/package. I haven't been able to find the docs yet, so I'll assume it doesn't exist.

Would I begin by creating a paszlib.xml file in the root of the fpcdocs? or should it go someplace else?

Thanks for your help, Scott Pascoe

Op Wed, 20 Sep 2006, schreef Scott Pascoe:

To my knowledge there exists no paszlib documentation, so if you could contribute some, this would be much appreciated.

Would I begin by creating a paszlib.xml file in the root of the fpcdocs? or should it go someplace else?

No, you can go ahead.

Daniël

I don't know, if you already know this, but you can use the makeskel command to create an empty paszlib.xml file.

Vincent

That's not true ;) there is a program called makeskel in the fpdoc dir to create an xml skeleton.

Ok,

Assuming that the makeskel has been run, then it would probably need to be fleshed out. So, would the proper location for the xml documentation file be in the root of the fpcdoc and should it be named paszlib.xml?

Thank you for the clarification and help,

Scott Pascoe wrote

Is the paszlib package documented in the fpcdocs?

No, it is not.

It goes in the docs dir.
You can create an empty file using makeskel.

Michael.

Yes.

Michael.

Back with another question...

I've run into an error using makeskel and haven't figured out how to fix it.

running makeskel with all of the .pas files in paszlib generated an unhandled exception.

I've narrowed it down to the zbase.pas file, so a command line of :

makeskel --package=paszlib --output=paszlib.xml --input=zbase.pas

throws:

An unhandled exception occurred at $00420B12 :
EParserError : Invalid character '?'
$00420B12
$00420CD4
$00420954
$0042059E
$004028DA

I searched the file for ? and found a deliberate syntax error if MAX_MATCH_IS_258 is not defined (at line 374).

This is defined in the zconf.inc file that is included at the beginning of the zbase.pas file.

I tried a commandline of:

makeskel --package=paszlib --output=paszlib.xml --input='-dMAX_MATCH_IS_258 zbase.pas'

but the result was no different.

Can you give me a clue on what I'm doing wrong?

Thanks, Scott

Op Wed, 20 Sep 2006, schreef Scott Pascoe:

but the result was no different. Can you give me a clue on what I'm doing wrong?

Simply fix the syntax error in the source. I think the fpc parser might have a reason to scan the {$else} part, so it will abort. You only need to do this once, so it is easiest to temporarily remove the syntax error.

Daniël

Daniël,

Thanks, I did that right after I sent the email and got it to generate. Glad to know I'm thinking along the correct lines here.

Before I get too much further, the generated xml file has a comment

<!-- unresolved type reference Visibility: default --> <element name="zbase">
...

Is this indicating that it couldn't find the zbase unit?

Scott Pascoe wrote:

You know also that there are gui tools to write the docs?

Florian Klaempfl wrote

Scott Pascoe wrote: You know also that there are gui tools to write the docs?

I was just about to mention that to Scott as well. I made some improvements to the "lazde" (documentation editor included with Lazarus). I am busy working on some more improvements.

If you don't have Lazarus, have a look at "fpde" included with Free Pascal - I believe this is what lazde was based on, but not sure if anybody is maintaining it. Even so, it uses the gtk widget set and will make your documentation process much easier!

Source Locations for both apps:
Lazarus: doceditor/lazde
Free Pascal: utils/fpdoc/fpde

Regards,
- Graeme -

No.
Unit references are simply stored that way. I would like to fix this once, but I haven't gotten around to it yet.

Michael.