PasDoc 0.14.0 released

[michalis]

PasDoc is a documentation tool for Object Pascal code, able to parse all modern Pascal features. Documentation is generated from comments found in your source code and from external files. Output formats include HTML and LaTeX. More information about PasDoc is available in our wiki: http://pasdoc.sourceforge.net/ .

Download the latest version from https://sourceforge.net/projects/pasdoc/files/ !

Version 0.14.0 includes many improvements and fixes:

• Many fixes to parsing "deprecated", "platform", "library" directives.
• simplexml output fixes (by Denis Grinyuk)
• The document creation time is not printed in the docs by default. Use "--include-creation-time" to show it. --include-creation-time is orthogonal to --exclude-generator.
• The build duration time is not printed in the output by default. Use "--verbosity 3" to show it.
• Brazilian utf8 translation (by Alexsander da Rosa)
• Upgrade tipue to 3.0.1, update jquery to 2.0.0.
• Fix Delphi compilation (long generated tipue code) (thanks to Marcos Rocha for investigating)
• Add pasdoc_gui icon (by Karl-Michael Schindler)
• Copyrights and docs fixes (thanks to Paul Gevers)
• Various other small fixes and code cleanups.

[aradeonas]

Is there any demo of output?
Also after 15 years give it a major number in the version

[michalis]

Is there any demo of output?

Sure: http://pasdoc.sipsolutions.net/PasDocAutoDoc . Note that you can configure the output a lot, e.g. for HTML using CSS , custom header/footer, custom introduction...

Also after 15 years give it a major number in the version

Maybe next release:)

[wp]

From http://pasdoc.sipsolutions.net/WhereToPlaceComments I am getting the impression that documentation must be located in the interface part of a unit. Since I want to keep the interface as compact as possible I'd prefer to write the documentation in the implementation part. Is this possible? Or if not, do you plan to implement this feature?

[michalis]

From http://pasdoc.sipsolutions.net/WhereToPlaceComments I am getting the impression that documentation must be located in the interface part of a unit. Since I want to keep the interface as compact as possible I'd prefer to write the documentation in the implementation part. Is this possible? Or if not, do you plan to implement this feature?

This feature was requested a couple of times. Personally I'm not working on it (because, for me, I like to have docs in the interface; I don't mind having a long interface; I can always see the compact version in PasDoc summary output). But I know that it's a matter of preference, and contributions towards this feature are very much welcome! See http://pasdoc.sipsolutions.net/WantedFeaturesParsingImplementation --- we had some talks about it on the mailing  lists, and everyone agrees that we want to add this feature, but so far noone found the time to implement it.

So, in short: we want it, and if you want it too -- contributions are most welcome:) Patches to SVN, or git pull request through https://github.com/michaliskambi/pasdoc are very welcome.

[Ñuño_Martínez]

Cool.  I use it a lot, so is good to see it's still alive.  I don't care if it has few releases thought (if it is good and has no bugs, why to modify it?).

Anyway I must to talk with you about the Spanish language (Castillian actually, which is the "es-es" language).  I think I tell you before, it is not correctly translated and there's a problem with charset coding (ISO vs. UTF vs. HTML entities), or it was in previous releases.  Unfortunatelly I'm pretty bussy now (creating my job) but I want to help.

[michalis]

Cool.  I use it a lot, so is good to see it's still alive.  I don't care if it has few releases thought (if it is good and has no bugs, why to modify it?).

Thanks!

Anyway I must to talk with you about the Spanish language (Castillian actually, which is the "es-es" language).  I think I tell you before, it is not correctly translated and there's a problem with charset coding (ISO vs. UTF vs. HTML entities), or it was in previous releases.  Unfortunatelly I'm pretty bussy now (creating my job) but I want to help.

Please do help --- write exactly what is wrong / how it needs to be modified. I don't speak/understand Spanish/Castillian myself, so it all depends on you! Please test the latest version, and if anything still needs to be fixed, report it. If you are able, you can get PasDoc sources from SourceForge SVN or GitHub repo, and even send a patch/pull request. The language files are inside source/component/lang/ directory, you can browse them e.g. from here: http://svn.code.sf.net/p/pasdoc/code/trunk/source/component/lang/ .

[tk]

Have been using DiPasDoc. Is your tool compatible?

[michalis]

Have been using DiPasDoc. Is your tool compatible?

As for DIPasDoc: long, long time ago our PasDoc was created because DIPasDoc seemed to violate the GPL license. Both projects started from "old PasDoc" by Marco Schmidt. See old mailing list threads and google for details... I wasn't even active user of PasDoc back then, so I only know it myself from mailing list archives.

So, the projects do share basic functionality and idea (comments are in source code, use @tags), but a lot of development happened since then. I'm pretty sure that PasDoc has a lot of features more than DiPasDoc (many new @-tags, LaTeX output, portable to FPC and non-Windows OSes etc.), and DIPasDoc doesn't seem to be developed anymore. So upgrading your projects from DIPasDoc to PasDoc should be straightforward and I would encourage you to do it:)

[wp]

I wonder why PasDoc_Gui uses such a pixelated blown-up font which is strange and unusual at least in Windows 7. If you'd delete the hard-coded font name "MS Sans Serif" from the frmHelpGeneratorUnit.Font and set its "Size" to 0 then the program would look like any standard Lazarus program in Windows.

[michalis]

I wonder why PasDoc_Gui uses such a pixelated blown-up font which is strange and unusual at least in Windows 7. If you'd delete the hard-coded font name "MS Sans Serif" from the frmHelpGeneratorUnit.Font and set its "Size" to 0 then the program would look like any standard Lazarus program in Windows.

Thanks. It actually fixes font everywhere --- e.g. on my Debian pasdoc_gui had a font smaller than my default. Now the font should be just default.

I committed the approproate change. You can test it looking at pasdoc from SVN or using development snapshots, http://pasdoc.sipsolutions.net/DevelopmentSnapshots . Personally I only tested it on Linux now.

[Ñuño_Martínez]

Please do help (...)

Sorry for the hiatus.

I did some of the changes on a previous version, and it wasn't hard.  I'll try to rescue them and adapt it to the SVN version.