Re: [fpc-pascal] FPDoc now with Markdown support

2021-01-04 Thread Bo Berglund via fpc-pascal
On Mon, 4 Jan 2021 11:38:09 +0100 (CET), Michael Van Canneyt via fpc-pascal wrote: >> Is there an MD renderer created with free pascal that can be plugged >> into Apache webserver so that the MD files are rendered correctly in >> any browser? > >You can use for example this one to translate markd

Re: [fpc-pascal] FPDoc now with Markdown support

2021-01-04 Thread Michael Van Canneyt via fpc-pascal
On Mon, 4 Jan 2021, Bo Berglund via fpc-pascal wrote: On Sat, 2 Jan 2021 15:31:11 +0100 (CET), Michael Van Canneyt via fpc-pascal wrote: Hello ! I didn't make it quite in time for the new year, but still: The fpdoc engine (what is used to document the FPC & Lazarus units) is now capable

Re: [fpc-pascal] FPDoc now with Markdown support

2021-01-04 Thread Bo Berglund via fpc-pascal
On Sat, 2 Jan 2021 15:31:11 +0100 (CET), Michael Van Canneyt via fpc-pascal wrote: > >Hello ! > >I didn't make it quite in time for the new year, but still: > >The fpdoc engine (what is used to document the FPC & Lazarus units) >is now capable of outputting the documentation in markdown. > Ques

Re: [fpc-pascal] FPDoc now with Markdown support

2021-01-02 Thread Michael Van Canneyt via fpc-pascal
On Sat, 2 Jan 2021, Marco van de Voort via fpc-pascal wrote: Op 2021-01-02 om 15:31 schreef Michael Van Canneyt via fpc-pascal: Hello ! I didn't make it quite in time for the new year, but still: The fpdoc engine (what is used to document the FPC & Lazarus units) is now capable of output

Re: [fpc-pascal] FPDoc now with Markdown support

2021-01-02 Thread Marco van de Voort via fpc-pascal
Op 2021-01-02 om 15:31 schreef Michael Van Canneyt via fpc-pascal: Hello ! I didn't make it quite in time for the new year, but still: The fpdoc engine (what is used to document the FPC & Lazarus units) is now capable of outputting the documentation in markdown. After this update I get exc

Re: [fpc-pascal] FPDoc now with Markdown support

2021-01-02 Thread Noel Duffy via fpc-pascal
On 3/01/21 3:31 am, Michael Van Canneyt via fpc-pascal wrote: Hello ! I didn't make it quite in time for the new year, but still: The fpdoc engine (what is used to document the FPC & Lazarus units) is now capable of outputting the documentation in markdown. This can be used as input for mkdo

[fpc-pascal] FPDoc now with Markdown support

2021-01-02 Thread Michael Van Canneyt via fpc-pascal
Hello ! I didn't make it quite in time for the new year, but still: The fpdoc engine (what is used to document the FPC & Lazarus units) is now capable of outputting the documentation in markdown. This can be used as input for mkdocs or another engine such as sphinx. As a first engine, I tack

Re: [fpc-pascal] fpdoc: what does the --marco parameter do?

2019-03-24 Thread Michael Van Canneyt
On Sat, 23 Mar 2019, Graeme Geldenhuys wrote: The FPDoc PDF documentation for 3.0.4 doesn't mention it at all. So maybe it is something for 3.2.0 and later only? Yes. The XML project file needs some parametrization - for example the location of the sources. So it contains macros. The --m

Re: [fpc-pascal] fpdoc: what does the --marco parameter do?

2019-03-23 Thread Sven Barth via fpc-pascal
Graeme Geldenhuys schrieb am Sa., 23. März 2019, 17:40: > On 23/03/2019 16:34, Graeme Geldenhuys wrote: > > I'm trying to debug fpdoc, but for the life of me, I can't get Lazarus > > to step into the code other than the program unit's main code block. > > Got this part sorted - MSEide to the resc

Re: [fpc-pascal] fpdoc: what does the --marco parameter do?

2019-03-23 Thread Graeme Geldenhuys
On 23/03/2019 16:34, Graeme Geldenhuys wrote: > I'm trying to debug fpdoc, but for the life of me, I can't get Lazarus > to step into the code other than the program unit's main code block. Got this part sorted - MSEide to the rescue! I set the exact same run parameters (starting directory and --p

[fpc-pascal] fpdoc: what does the --marco parameter do?

2019-03-23 Thread Graeme Geldenhuys
The FPDoc PDF documentation for 3.0.4 doesn't mention it at all. So maybe it is something for 3.2.0 and later only? I'm trying to debug fpdoc, but for the life of me, I can't get Lazarus to step into the code other than the program unit's main code block. I set the starting directory, I set the --

Re: [fpc-pascal] fpdoc error with XML parsing

2018-07-03 Thread George Bakhtadze
"--" in comments is not allowed by XML standard.As a workaround it may be replaced by it's UTF-8 equivalent "-".https://stackoverflow.com/questions/10842131/xml-comments-and 03.07.2018, 02:08, "Graeme Geldenhuys" :> On 07/02/18 21:28, wkitt...@windstream.net wrote:>>  can fpdoc process comments spa

Re: [fpc-pascal] fpdoc error with XML parsing

2018-07-03 Thread Bart
On Tue, Jul 3, 2018 at 6:52 PM, wrote: >> So I guess "--" is not allowed inside a >> xml comment block. Another reason to dislike XML. ;-) W3C XML validator says it's invalid XML: " invalid comment declaration: found name start character outside comment but inside comment declaration" and it p

Re: [fpc-pascal] fpdoc error with XML parsing

2018-07-03 Thread wkitty42
On 07/02/2018 07:07 PM, Graeme Geldenhuys wrote: From that error message it doesn't seem to like the "--macro" part inside the xml comment. It seems fpdoc wants to process that "--" as the end of the comment. this was where i was headed... if the multi-line comments work properly, perhaps it i

Re: [fpc-pascal] fpdoc error with XML parsing

2018-07-02 Thread Graeme Geldenhuys
On 07/02/18 21:28, wkitt...@windstream.net wrote: > can fpdoc process comments spanning multiple lines? Yes it can. That same XML file contains multi-line comments too, and those don't give issues. eg: ...snip... ...snip... =

Re: [fpc-pascal] fpdoc error with XML parsing

2018-07-02 Thread wkitty42
On 07/02/2018 04:11 PM, Graeme Geldenhuys wrote: What is illegal about this fpdoc XML project file? fpdoc from FPC 3.1.1 keeps giving an exception error reading the XML document. The issue it has is with the XML Comment I have on lines 2-5 (ignore the line wrapping caused by my email client). If

[fpc-pascal] fpdoc error with XML parsing

2018-07-02 Thread Graeme Geldenhuys
Hi, What is illegal about this fpdoc XML project file? fpdoc from FPC 3.1.1 keeps giving an exception error reading the XML document. The issue it has is with the XML Comment I have on lines 2-5 (ignore the line wrapping caused by my email client). If I remove that comment, then the XML is read, p

Re: [fpc-pascal] FPDoc - how to document overloaded functions?

2017-07-13 Thread wkitty42
On 07/13/2017 06:30 AM, Michael Van Canneyt wrote: I'm not sure I understand what you're trying to achieve ? @graeme: maybe you could mock up what you are wanting/expecting from this particular situation? that way we (TINW) could compare the two and see the difference?? -- NOTE: No off-l

Re: [fpc-pascal] FPDoc - how to document overloaded functions?

2017-07-13 Thread Michael Van Canneyt
On Wed, 12 Jul 2017, Graeme Geldenhuys wrote: On 2017-07-12 15:06, Michael Van Canneyt wrote: You can't. There are no provisions for this. I usually make the differences clear in the node. Thanks Michael. I've been playing around with fpdoc and trying a few things and then reviewing th

Re: [fpc-pascal] FPDoc - how to document overloaded functions?

2017-07-12 Thread Graeme Geldenhuys
On 2017-07-12 15:06, Michael Van Canneyt wrote: You can't. There are no provisions for this. I usually make the differences clear in the node. Thanks Michael. I've been playing around with fpdoc and trying a few things and then reviewing the results. Attached is the output I have thus far

Re: [fpc-pascal] FPDoc - how to document overloaded functions?

2017-07-12 Thread Graeme Geldenhuys
On 2017-07-12 15:19, Graeme Geldenhuys wrote: ps #1: I haven't tried documenting function results yet, so not sure what FPDOC is going to do with that in this output. I had a look at documenting function results. There seems to be a bug (or place for improvement) in the HTML output. Even w

Re: [fpc-pascal] FPDoc - how to document overloaded functions?

2017-07-12 Thread Michael Van Canneyt
On Wed, 12 Jul 2017, Graeme Geldenhuys wrote: Hi, How do you document overloaded functions? In this case I have overloaded functions that have different parameters (obviously), but also different result types. You can't. There are no provisions for this. I usually make the differences cl

Re: [fpc-pascal] FPDoc - how to document a function result?

2017-07-12 Thread Michael Van Canneyt
On Wed, 12 Jul 2017, Graeme Geldenhuys wrote: As the subject line says. Do I simply create a ELEMENT take with the function name and ".Result"? For example: This is the function result documentation. Or is there some other syntax? This is the correct syntax. Michael. ___

[fpc-pascal] FPDoc - how to document overloaded functions?

2017-07-12 Thread Graeme Geldenhuys
Hi, How do you document overloaded functions? In this case I have overloaded functions that have different parameters (obviously), but also different result types. I've been looking through the FPDoc PDF manual, but there is no explicit information on this subject. But then, I could be over

[fpc-pascal] FPDoc - how to document a function result?

2017-07-12 Thread Graeme Geldenhuys
As the subject line says. Do I simply create a ELEMENT take with the function name and ".Result"? For example: This is the function result documentation. Or is there some other syntax? Regards, Graeme -- fpGUI Toolkit - a cross-platform GUI toolkit using Free Pascal http://fpgui.sourc

Re: [fpc-pascal] fpdoc fixes for FPC 3.0.2

2016-04-19 Thread Michael Van Canneyt
On Tue, 19 Apr 2016, Graeme Geldenhuys wrote: Hi, I have some fixes for fpdoc [and more to come] and would like them applied to FPC 3.0.2 if possible. Is there an estimate cut-off date for back-porting fixes to 3.0.2, or is there no release date set for 3.0.2 yet. No release date set yet.

[fpc-pascal] fpdoc fixes for FPC 3.0.2

2016-04-19 Thread Graeme Geldenhuys
Hi, I have some fixes for fpdoc [and more to come] and would like them applied to FPC 3.0.2 if possible. Is there an estimate cut-off date for back-porting fixes to 3.0.2, or is there no release date set for 3.0.2 yet. Regards, Graeme -- fpGUI Toolkit - a cross-platform GUI toolkit using Free

Re: [fpc-pascal] fpdoc project file

2015-12-06 Thread Michael Van Canneyt
On Sun, 6 Dec 2015, Mattias Gaertner wrote: Hi, The 3.1.1 fpdoc -h help has some confusing items. Can someone explain them please: --project=fileUse file as project file The command-line can get very long. Instead, you can write a project file with all options in it. --write-projec

[fpc-pascal] fpdoc project file

2015-12-06 Thread Mattias Gaertner
Hi, The 3.1.1 fpdoc -h help has some confusing items. Can someone explain them please: --project=fileUse file as project file --write-project=file Do not write documentation, create project file instead --write-project=file Write all command-line options to

Re: [fpc-pascal] fpdoc - "all known implementing classes" section

2015-10-04 Thread Michael Van Canneyt
On Sun, 4 Oct 2015, Graeme Geldenhuys wrote: Hi, Does FPDoc have the functionality to show "All known implementing classes" for an Interface or Class? Something like what JavaDoc does. Here is an example: http://docs.oracle.com/javase/7/docs/api/javax/swing/text/Document.html If not, I'm

Re: [fpc-pascal] fpdoc - "all known implementing classes" section

2015-10-04 Thread Graeme Geldenhuys
On 2015-10-04 13:11, Graeme Geldenhuys wrote: > Does FPDoc have the functionality to show "All known implementing > classes" for an Interface or Class? And here is a JavaDoc example of a Class and sub-classes. http://docs.oracle.com/javase/7/docs/api/javax/swing/text/AbstractDocument.html Regar

[fpc-pascal] fpdoc - "all known implementing classes" section

2015-10-04 Thread Graeme Geldenhuys
Hi, Does FPDoc have the functionality to show "All known implementing classes" for an Interface or Class? Something like what JavaDoc does. Here is an example: http://docs.oracle.com/javase/7/docs/api/javax/swing/text/Document.html If not, I'm guess the information is there, it would just be

Re: [fpc-pascal] fpdoc HTML class hierarchy output contains duplicates

2015-08-01 Thread Graeme Geldenhuys
On 2015-07-26 12:45, Michael Van Canneyt wrote: > Fixed it as part of the 3.0 release process. Fantastic, many thanks Michael. I need to regenerate tiOPF's documentation anyway, so will use 3.0 RC to test it. Regards, - Graeme - -- fpGUI Toolkit - a cross-platform GUI toolkit using Free Pasc

Re: [fpc-pascal] fpdoc HTML class hierarchy output contains duplicates

2015-07-26 Thread Michael Van Canneyt
On Tue, 21 Jul 2015, Michael Van Canneyt wrote: On Tue, 21 Jul 2015, Graeme Geldenhuys wrote: Hi, Last night I came across something, which I think is a bug in fpdoc's HTML output. In recent times, fpdoc added a new output feature to the HTML generated - a class hierarchy page. Here is r

Re: [fpc-pascal] fpdoc HTML class hierarchy output contains duplicates

2015-07-21 Thread Michael Van Canneyt
On Tue, 21 Jul 2015, Graeme Geldenhuys wrote: Hi, Last night I came across something, which I think is a bug in fpdoc's HTML output. In recent times, fpdoc added a new output feature to the HTML generated - a class hierarchy page. Here is recent HTML output I generated for the tiOPF project.

[fpc-pascal] fpdoc HTML class hierarchy output contains duplicates

2015-07-21 Thread Graeme Geldenhuys
Hi, Last night I came across something, which I think is a bug in fpdoc's HTML output. In recent times, fpdoc added a new output feature to the HTML generated - a class hierarchy page. Here is recent HTML output I generated for the tiOPF project. Note all the duplicates in the Class Hierarchy pag

Re: [fpc-pascal] fpdoc to use custom CSS file for HTML output

2015-03-10 Thread Graeme Geldenhuys
On 2015-03-10 13:41, Michael Van Canneyt wrote: > > I am open for different formatting for the documentation. > It would be nice to have a set of 'themes'. Attached is what I worked on last night - still need a few tweaks (media support). It will be the new theme for fpGUI's class docs in the up

Re: [fpc-pascal] fpdoc to use custom CSS file for HTML output

2015-03-10 Thread Michael Van Canneyt
On Tue, 10 Mar 2015, Graeme Geldenhuys wrote: On 2015-03-10 13:26, Michael Van Canneyt wrote: You can. It's an error in the usage message. Brilliant - I can confirm it works! It is apparently an error/bug in the fpdoc documentation too. http://www.freepascal.org/docs-html/fpdoc/fpdocsu6.

Re: [fpc-pascal] fpdoc to use custom CSS file for HTML output

2015-03-10 Thread Graeme Geldenhuys
On 2015-03-10 13:26, Michael Van Canneyt wrote: > You can. It's an error in the usage message. Brilliant - I can confirm it works! It is apparently an error/bug in the fpdoc documentation too. http://www.freepascal.org/docs-html/fpdoc/fpdocsu6.html#x18-170003.2.6 Regards, - Graeme - -- f

Re: [fpc-pascal] fpdoc to use custom CSS file for HTML output

2015-03-10 Thread Michael Van Canneyt
On Tue, 10 Mar 2015, Graeme Geldenhuys wrote: Hi, Why is the --css-file option limited to the CHM output? Why can't I specify it for the HTML output too? You can. It's an error in the usage message. Michael. ___ fpc-pascal maillist - fpc-pasca

[fpc-pascal] fpdoc to use custom CSS file for HTML output

2015-03-10 Thread Graeme Geldenhuys
Hi, Why is the --css-file option limited to the CHM output? Why can't I specify it for the HTML output too? Alternatively, how do I tell fpdoc not to use the default (built-in) fpdoc.css, but rather use my version. Regards, - Graeme - -- fpGUI Toolkit - a cross-platform GUI toolkit using F

Re: [fpc-pascal] FPDoc an deprecated functions

2015-03-10 Thread Michael Van Canneyt
On Tue, 10 Mar 2015, Graeme Geldenhuys wrote: Hi, Is the tag the only way to mark methods or functions deprecated in the documentation? I've just tried the latest fpdoc from trunk and it doesn't seem to show the deprecated keyword in the "Declaration" section of the documentation. This is

[fpc-pascal] FPDoc an deprecated functions

2015-03-10 Thread Graeme Geldenhuys
Hi, Is the tag the only way to mark methods or functions deprecated in the documentation? I've just tried the latest fpdoc from trunk and it doesn't seem to show the deprecated keyword in the "Declaration" section of the documentation. I'm happy using the VERSION tag, but just wondered if there

Re: [fpc-pascal] fpdoc project file: multiple output formats

2013-04-30 Thread Marco van de Voort
In our previous episode, Michael Van Canneyt said: > > I meant one project-file-that-$includes-base-filesetup, so that you can have > > one project per backend without duplicating the main file related settings. > > > > Or can you have multiple backend options for different backends per project > >

Re: [fpc-pascal] fpdoc project file: multiple output formats

2013-04-30 Thread Michael Van Canneyt
On Tue, 30 Apr 2013, Graeme Geldenhuys wrote: On 2013-04-30 08:07, Michael Van Canneyt wrote: Well, I would be to blame for this. :-) But when I do domething like that, then only the backend options would be allowed to differ. I see no need to put all options in backend-specific option

Re: [fpc-pascal] fpdoc project file: multiple output formats

2013-04-30 Thread Michael Van Canneyt
On Tue, 30 Apr 2013, Marco van de Voort wrote: In our previous episode, Michael Van Canneyt said: I think that is better. Nearly all options have some special params (like --auto-toc --auto-index --make-searchable etc) These are already supported. Everything not recognized as 'global' is a

Re: [fpc-pascal] fpdoc project file: multiple output formats

2013-04-30 Thread Marco van de Voort
In our previous episode, Michael Van Canneyt said: > > I think that is better. Nearly all options have some special params (like > > --auto-toc --auto-index --make-searchable etc) > > These are already supported. > > Everything not recognized as 'global' is added to backendoptions, a > stringlis

Re: [fpc-pascal] fpdoc project file: multiple output formats

2013-04-30 Thread Graeme Geldenhuys
On 2013-04-30 08:07, Michael Van Canneyt wrote: > Well, I would be to blame for this. :-) > But when I do domething like that, then only the backend options would be > allowed > to differ. I see no need to put all options in backend-specific option sets: > the input files etc. should not diffe

Re: [fpc-pascal] fpdoc project file: multiple output formats

2013-04-30 Thread Michael Van Canneyt
On Tue, 30 Apr 2013, Marco van de Voort wrote: In our previous episode, Michael Van Canneyt said: A simpler solution could also be the support for an include of a separate file. Then you could put common things (list of files) in one file, and create top-level files per format you want to pro

Re: [fpc-pascal] fpdoc project file: multiple output formats

2013-04-30 Thread Marco van de Voort
In our previous episode, Michael Van Canneyt said: > A simpler solution could also be the support for an include of a separate > file. > Then you could put common things (list of files) in one file, and create > top-level files per format you want to produce. I think that is better. Nearly all

Re: [fpc-pascal] fpdoc project file: multiple output formats

2013-04-30 Thread Michael Van Canneyt
On Mon, 29 Apr 2013, Graeme Geldenhuys wrote: Hi, I'm using a fpdoc project file for fpGUI documentation. The project file idea works much better than a massive set of command line parameters. So kudos to whoever thought of the project file idea. Well, I would be to blame for this. I jus

[fpc-pascal] fpdoc project file: multiple output formats

2013-04-29 Thread Graeme Geldenhuys
Hi, I'm using a fpdoc project file for fpGUI documentation. The project file idea works much better than a massive set of command line parameters. So kudos to whoever thought of the project file idea. I just have one question though Can the project file manage two or more output formats? It i

Re: [fpc-pascal] fpdoc enhanced - call for tests

2012-12-20 Thread Graeme Geldenhuys
On 20/12/12 16:31, Michael Van Canneyt wrote: > > I have enhanced fpdoc. > It now creates a (clickable) hierarchy of the classes in the package that is > documented. Ah, you beat me to it! I saw this in PasDoc the other day, and thought that would be nice in fpdoc too, so that was going to be

[fpc-pascal] fpdoc enhanced - call for tests

2012-12-20 Thread Michael Van Canneyt
Hi, I have enhanced fpdoc. It now creates a (clickable) hierarchy of the classes in the package that is documented. A sample of what it will look like is available at http://www.freepascal.org/docs-html/rtl/index-9.html http://www.freepascal.org/docs-html/fcl/index-9.html The tree can b

Re: [fpc-pascal] fpdoc output "parsing used unit..."

2012-12-04 Thread Michael Van Canneyt
On Tue, 4 Dec 2012, Graeme Geldenhuys wrote: On 2012-12-04 16:52, Michael Van Canneyt wrote: Imagine unit A and unit B. Unit A references unit B. You create somewhere in A's documentation a link to an identifier in unit B. OK thanks. I'll try and reorder my units in the project file to see

Re: [fpc-pascal] fpdoc output "parsing used unit..."

2012-12-04 Thread Graeme Geldenhuys
On 2012-12-04 16:52, Michael Van Canneyt wrote: > > Imagine unit A and unit B. Unit A references unit B. > You create somewhere in A's documentation a link to an identifier in unit B. OK thanks. I'll try and reorder my units in the project file to see if this can be improved. I thought order wa

Re: [fpc-pascal] fpdoc output "parsing used unit..."

2012-12-04 Thread Michael Van Canneyt
On Tue, 4 Dec 2012, Graeme Geldenhuys wrote: Hi, This seems new in FPC 2.7.1. I have some 15-20 units in my .xml project file that fpdoc uses, but only a select few units generate output like "Parsing used unit ..." What does that output mean? Is in some error? And why the output only for a

Re: [fpc-pascal] fpdoc exclude option

2012-12-04 Thread Michael Van Canneyt
On Tue, 4 Dec 2012, Graeme Geldenhuys wrote: Hi, Is there an option in fpdoc description files to exclude a class, type, global variable, global procedure etc from documentation? Something like PasDoc's @exclude functionality? I just want to know if it already exists, or if somebody is alr

[fpc-pascal] fpdoc output "parsing used unit..."

2012-12-04 Thread Graeme Geldenhuys
Hi, This seems new in FPC 2.7.1. I have some 15-20 units in my .xml project file that fpdoc uses, but only a select few units generate output like "Parsing used unit ..." What does that output mean? Is in some error? And why the output only for a few units, and not all units? 8<

[fpc-pascal] fpdoc exclude option

2012-12-04 Thread Graeme Geldenhuys
Hi, Is there an option in fpdoc description files to exclude a class, type, global variable, global procedure etc from documentation? Something like PasDoc's @exclude functionality? I just want to know if it already exists, or if somebody is already working on this, before I start on it. Rega

Re: [fpc-pascal] fpdoc and linked elements

2012-12-04 Thread Graeme Geldenhuys
On 2012-12-04 16:22, Michael Van Canneyt wrote: > > Well, I've had some issues myself, but never managed to pinpoint the > exact reason. Somehow, when trying to construct test cases, the problem > does not pop up: it proves to be very elusive. I'll dig deeper and see what I can find. This bug

Re: [fpc-pascal] fpdoc and linked elements

2012-12-04 Thread Michael Van Canneyt
On Tue, 4 Dec 2012, Graeme Geldenhuys wrote: Hi Michael (or anybody else that could help), I have a xml description file with the following elements. The first one (for ImageName property) which doesn't list the unit name in the link attribute, is never found by fpdoc. So the generated docum

[fpc-pascal] fpdoc and linked elements

2012-12-04 Thread Graeme Geldenhuys
Hi Michael (or anybody else that could help), I'm using fpdoc from FPC 2.7.1 (pulled yesterday from the repository). I have a xml description file with the following elements. --[ fpg_button.xml ]- ---[ end ]--- What is the correct format for

[fpc-pascal] fpdoc executable both in bin and utils\fpdoc - but not fpdoc.css

2012-08-12 Thread Reinier Olislagers
In my (Windows) SVN fpc installs, I can find the fpdoc executable both under the bin directory as well as utils\fpdoc However, I've only found fpdoc.css in utils\fpdoc (and a different one in packages\fcl-res\xml) but not in the bin directory. IIRC, fpdoc picks up fpdoc.css when generating HTML/C

[fpc-pascal] fpdoc is broken for LINK'ed documentation

2012-03-02 Thread Graeme Geldenhuys
Hi, I've been trying to figure this out all morning, and after 2 hours I still can't see why fpdoc doesn't work correctly. I have linked documentation in descendant classes - so as not to duplicate documentation in the XML description files. I currently use the IPF linear output writer, and DO sp

Re: [fpc-pascal] fpdoc slow on Linux x64... tweaking?

2012-02-22 Thread Graeme Geldenhuys
On 22 February 2012 11:38, Reinier Olislagers wrote: > > In order to be ready for that, would you care to share your build_ipf.sh? No problem, there is nothing special about it really. Just and inclusion of two parameters I don't have to keep retyping. :) It must be run from the /docs/html/ dire

Re: [fpc-pascal] fpdoc slow on Linux x64... tweaking?

2012-02-22 Thread Reinier Olislagers
On 22-2-2012 9:16, Graeme Geldenhuys wrote: > On 22 February 2012 09:49, Reinier Olislagers wrote: >> 2) Is there anything else I can do to speed up LCL doc generation? > > You are building CHM help, correct? If so, from recent messages in the > FPC and Lazarus mailing lists, that is your problem

Re: [fpc-pascal] fpdoc slow on Linux x64... tweaking?

2012-02-22 Thread Graeme Geldenhuys
On 22 February 2012 09:49, Reinier Olislagers wrote: > 2) Is there anything else I can do to speed up LCL doc generation? You are building CHM help, correct? If so, from recent messages in the FPC and Lazarus mailing lists, that is your problem, not fpdoc per-se. The CHM generation package is ver

[fpc-pascal] fpdoc slow on Linux x64... tweaking?

2012-02-21 Thread Reinier Olislagers
Running fpcup on Linux x86, Linux x64 with FPC fixes_2_6 Building LCL chm docs with build_lcl_docs, which calls fpdoc: On x86, seems to works ok. On x64, takes a long time. fpdoc takes a huge amount of CPU (perhaps memory as well, haven't looked). I suspect the reason the doc generation is slow i

Re: [fpc-pascal] fpdoc and tab characters

2012-02-13 Thread Michael Van Canneyt
On Mon, 13 Feb 2012, Mattias Gaertner wrote: Hi,   How are tab characters handled by fpdoc and its output formats? Depends on the output format. See escapetext in the writer descendents. Function EscapeText(S : String) : String; override; Michael._

[fpc-pascal] fpdoc and tab characters

2012-02-13 Thread Mattias Gaertner
Hi, How are tab characters handled by fpdoc and its output formats? Mattias ___ fpc-pascal maillist - fpc-pascal@lists.freepascal.org http://lists.freepascal.org/mailman/listinfo/fpc-pascal

Re: [fpc-pascal] fpdoc links and short description

2012-01-27 Thread Felipe Monteiro de Carvalho
Aha! I found the gotcha! If I write the link like this: Then it links properly (clicking makes it go to TCustomRadioGroup.OnSelectionChanged) but it will not copy the short description to the class overview. But it does that if I link like this:

Re: [fpc-pascal] fpdoc links and short description

2012-01-27 Thread Felipe Monteiro de Carvalho
On Fri, Jan 27, 2012 at 11:06 AM, wrote: > Most likely a bug, please report it. umm, now I have rebuilt the docs and it obtained the short description in the top-level view. I think I was using an old version of fpdoc ... -- Felipe Monteiro de Carvalho _

Re: [fpc-pascal] fpdoc links and short description

2012-01-27 Thread michael . vancanneyt
On Fri, 27 Jan 2012, Felipe Monteiro de Carvalho wrote: Hello, I havent seen an answer for this in the other thread and it is getting too big. So, in fpdoc if we make a link like this: It does not properly link the short description when listing elements of a class, for example. Is this a

[fpc-pascal] fpdoc links and short description

2012-01-27 Thread Felipe Monteiro de Carvalho
Hello, I havent seen an answer for this in the other thread and it is getting too big. So, in fpdoc if we make a link like this: It does not properly link the short description when listing elements of a class, for example. Is this a bug or should it work like this? Is it possible to link the

Re: [fpc-pascal] FPDoc visibility sections

2012-01-04 Thread dhkblaszyk
I filed the report here: http://bugs.freepascal.org/view.php?id=21022 [4] BTW, it think it has to do with overloaded methods. Whenever fpdoc encounters such methods it will enclose them in visibility directives. Regards, Darius On 4 jan '12, Michael Van Canneyt wrote: > On Wed, 4 Jan 20

Re: [fpc-pascal] FPDoc visibility sections

2012-01-04 Thread Michael Van Canneyt
On Wed, 4 Jan 2012, dhkblas...@zeelandnet.nl wrote: Found some strange behaviour imho. For some reason there are extra visibility sections inserted in my documentation, instead of following the source. I expected fpdoc to respect the visibility directives instead of deciding autonomously wh

[fpc-pascal] FPDoc visibility sections

2012-01-04 Thread dhkblaszyk
Found some strange behaviour imho. For some reason there are extra visibility sections inserted in my documentation, instead of following the source. I expected fpdoc to respect the visibility directives instead of deciding autonomously when to place one. See for example: documentation:http

Re: [fpc-pascal] fpdoc (fpc 2.4.2)

2011-02-11 Thread Mark Morgan Lloyd
Michael Van Canneyt wrote: On Fri, 11 Feb 2011, Mark Morgan Lloyd wrote: I'm currently working on a translator from SNMP MIB files to Pascal, and on a whim decided to see how well they documented. Two questions if I may. i) fpdoc appears to lose the fact that a procedure or function is pre

Re: [fpc-pascal] fpdoc (fpc 2.4.2)

2011-02-11 Thread Michael Van Canneyt
On Fri, 11 Feb 2011, Mark Morgan Lloyd wrote: I'm currently working on a translator from SNMP MIB files to Pascal, and on a whim decided to see how well they documented. Two questions if I may. i) fpdoc appears to lose the fact that a procedure or function is prefixed "class". Please fil

[fpc-pascal] fpdoc (fpc 2.4.2)

2011-02-11 Thread Mark Morgan Lloyd
I'm currently working on a translator from SNMP MIB files to Pascal, and on a whim decided to see how well they documented. Two questions if I may. i) fpdoc appears to lose the fact that a procedure or function is prefixed "class". ii) I've got comments associated with class procedures/funct

Re: [fpc-pascal] fpdoc tag syntax question

2010-08-10 Thread Graeme Geldenhuys
Op 2010-08-10 14:37, Michael Van Canneyt het geskryf: > > In one package, . should be enough in the description > text. > > In 'short' tags, however, something goes wrong when creating TOC pages that > use this tag, and the resolving goes wrong; so there > #.. > is needed. I can confirm that

Re: [fpc-pascal] fpdoc tag syntax question

2010-08-10 Thread Michael Van Canneyt
On Tue, 10 Aug 2010, Graeme Geldenhuys wrote: Hi, I read the fpdoc documentation, and think I understand it correctly, but would just like to confirm. For fpGUI's class documentation, it uses a single 'fpgui' package in the fpdoc command line, covering all the units documented. When one XML

[fpc-pascal] fpdoc tag syntax question

2010-08-10 Thread Graeme Geldenhuys
Hi, I read the fpdoc documentation, and think I understand it correctly, but would just like to confirm. For fpGUI's class documentation, it uses a single 'fpgui' package in the fpdoc command line, covering all the units documented. When one XML description file references another description fi

Re[2]: [fpc-pascal] fpdoc and multiple Include paths issue

2010-06-08 Thread José Mejuto
Hello FPC-Pascal, Tuesday, June 8, 2010, 2:23:52 PM, you wrote: >> I know, and tried both just too see. But as Jonas has said, FPC >> itself uses >> semi-colon on all platforms, hence the reason I tried semi-colon >> first. JM> The compiler should actually be changed to use the platform-specifi

Re: [fpc-pascal] fpdoc and multiple Include paths issue

2010-06-08 Thread Jürgen Hestermann
Jonas Maebe schrieb: because a directory on a unix platform can perfectly contain a semi-colon. That applies to Windows too. ___ fpc-pascal maillist - fpc-pascal@lists.freepascal.org http://lists.freepascal.org/mailman/listinfo/fpc-pascal

Re: [fpc-pascal] fpdoc and multiple Include paths issue

2010-06-08 Thread Graeme Geldenhuys
Op 2010-06-08 14:23, Jonas Maebe het geskryf: > > The compiler should actually be changed to use the platform-specific > separator, because a directory on a unix platform can perfectly > contain a semi-colon. I guess, but do you really want to go down that route? :-) Linux (and probably othe

Re: [fpc-pascal] fpdoc and multiple Include paths issue

2010-06-08 Thread Jonas Maebe
On 08 Jun 2010, at 14:16, Graeme Geldenhuys wrote: I know, and tried both just too see. But as Jonas has said, FPC itself uses semi-colon on all platforms, hence the reason I tried semi-colon first. The compiler should actually be changed to use the platform-specific separator, because a

Re: [fpc-pascal] fpdoc and multiple Include paths issue

2010-06-08 Thread Graeme Geldenhuys
Op 2010-06-08 13:26, Michael Van Canneyt het geskryf: > > No. You must specify a -Fi per path. It doesn't split the path. Umm, but FPC allows it in fpc.cfg file, so maybe allowing it in fpdoc will be more consistent don't you think. It should be rather easy to add. eg: A sample from FPC generate

Re: [fpc-pascal] fpdoc and multiple Include paths issue

2010-06-08 Thread Jonas Maebe
On 08 Jun 2010, at 13:26, Michael Van Canneyt wrote: No. You must specify a -Fi per path. It doesn't split the path. (coincidentally, the path separator is : on linux, not ; :)) At least for the fpc/ppcXXX binaries, the path separator is ";" on all platforms. Jonas __

Re: [fpc-pascal] fpdoc and multiple Include paths issue

2010-06-08 Thread Michael Van Canneyt
On Tue, 8 Jun 2010, Graeme Geldenhuys wrote: Hi Is fpdoc supposed to handle multiple include paths with one -Fi parameter? eg: --input='-Fi../src/corelib;../src/corelib/x11 ../src/corelib/fpg_utils.pas' --descr=xml/corelib/fpg_utils.xml \ The above line fails. fpdoc cannot find the inclu

[fpc-pascal] fpdoc and multiple Include paths issue

2010-06-08 Thread Graeme Geldenhuys
Hi Is fpdoc supposed to handle multiple include paths with one -Fi parameter? eg: --input='-Fi../src/corelib;../src/corelib/x11 ../src/corelib/fpg_utils.pas' --descr=xml/corelib/fpg_utils.xml \ The above line fails. fpdoc cannot find the include file used my fpg_utils.pas unit. Changing that

Re: [fpc-pascal] fpDoc Question

2010-05-08 Thread Lee Jenkins
Graeme Geldenhuys wrote: On 8 May 2010 15:53, Lee Jenkins wrote: Does fpDoc per chance understand the markup used by pasdoc? Specifically, I used comments like this: fpdoc doesn't use comments from inside the source code. Instead it reads the comments from an external XML file and merging it

Re: [fpc-pascal] fpDoc Question

2010-05-08 Thread Graeme Geldenhuys
On 8 May 2010 15:53, Lee Jenkins wrote: > > Does fpDoc per chance understand the markup used by pasdoc?  Specifically, I > used comments like this: fpdoc doesn't use comments from inside the source code. Instead it reads the comments from an external XML file and merging it with the source code t

[fpc-pascal] fpDoc Question

2010-05-08 Thread Lee Jenkins
Does fpDoc per chance understand the markup used by pasdoc? Specifically, I used comments like this: {: Particularly useful when applied to THusband or TBoyfriend. } ICleaner interface procedure CleanAfterSelf; end; {: Particularly useful when applied to TWife or TGirlfriend. } IGymnast =

Re: [fpc-pascal] fpdoc search engine progress

2009-03-16 Thread Vincent Snijders
leledumbo schreef: For off line search, using the chm output and a chm viewer would be good enough, don't you think? Yes, but I haven't seen the chm output in a while. Has it been able to generate a TOC like the one I made (based on directory structure)? I don't know if it is like the one

Re: [fpc-pascal] fpdoc search engine progress

2009-03-16 Thread leledumbo
> For off line search, using the chm output and a chm viewer would be good enough, > don't you think? Yes, but I haven't seen the chm output in a while. Has it been able to generate a TOC like the one I made (based on directory structure)? You may get it http://www.esnips.com/doc/914356c7-2aa2-

Re: [fpc-pascal] fpdoc search engine progress

2009-03-16 Thread Graeme Geldenhuys
On Mon, Mar 16, 2009 at 10:36 AM, Vincent Snijders wrote: > > For off line search, using the chm output and a chm viewer would be good > enough, don't you think? Umm, I haven't tried the new chm feature of fpdoc yet. I'll try this shortly. :) Regards, - Graeme -

Re: [fpc-pascal] fpdoc search engine progress

2009-03-16 Thread Vincent Snijders
leledumbo schreef: How's the progress of adding search engine to fpdoc? Either Graeme's work with Tipue and someone else's with Ioda. For off line search, using the chm output and a chm viewer would be good enough, don't you think? Vincent ___ fpc-

Re: [fpc-pascal] fpdoc search engine progress

2009-03-16 Thread Michael Van Canneyt
On Sun, 15 Mar 2009, leledumbo wrote: > > How's the progress of adding search engine to fpdoc? Either Graeme's work > with Tipue and someone else's with Ioda. There is none. I don't think tipue is a viable solution; Only ioda qualifies IMHO. Michael. __

  1   2   >