* * *

Author Topic: PasDoc 0.15.0 release  (Read 1349 times)

michalis

  • Jr. Member
  • **
  • Posts: 95
    • Homepage
PasDoc 0.15.0 release
« on: February 08, 2018, 11:53:34 pm »
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/ .

We have just released a new version 0.15.0. You can download it from https://sourceforge.net/projects/pasdoc/files/ . Or just grab the sources from GitHub and compile them yourself: https://github.com/pasdoc/pasdoc/ .

Here are the new features and fixes:

  • @links to enumerated type members work now.
  • New @includeCode tag https://github.com/pasdoc/pasdoc/wiki/IncludeCodeTag (by Silvio Clécio)
  • @longCode and @preformatted improved to better honor indentation.
  • Parsing "experimental" directive.
  • Allow to customize HTML output more, with your own CSS and HTML, by --html-head, --html-body-begin, --html-body-end command-line params.
  • HTML output is now HTML5.
  • Add our tools to the binary release: pascal_pre_proc (Pascal preprocessor), file_to_pascal_data, file_to_pascal_string.
  • Improve CSS and HTML, in particular for accessibility and mobile browsers. Among many improvements, we removed fixed font size in pixels, changed some tables into divs, and fixed HTML validity around Tipue search box.
  • pasdoc_gui uses now default font size on your system.
  • Updated Spanish (Spain) translation (by Guillermo Martínez Jiménez)
  • Tipue works now more efficiently -- the (potentially large) "index data" is only loaded on the "Search Results" page.
  • Automatic tests rearrangements and simplifications (see tests/run_all_tests.sh).

Thank you to everyone who contributed to this release, and to everyone who uses PasDoc.

P.S. We may not be the most active open-source project, but we're still alive:) Personally, I use PasDoc daily to generate documentation for Castle Game Engine ( https://castle-engine.sourceforge.io/apidoc/html/index.html ).

mischi

  • Jr. Member
  • **
  • Posts: 84
Re: PasDoc 0.15.0 release
« Reply #1 on: February 09, 2018, 11:59:15 pm »
The package descriptions of pasdoc for fink, the Debian-like package manager for macOS, are updated to the new version. 

Ñuño_Martínez

  • Hero Member
  • *****
  • Posts: 718
    • Burdjia
Re: PasDoc 0.15.0 release
« Reply #2 on: February 10, 2018, 01:33:15 pm »
Great!

I use it to generate the documentaion for my projecst too (i.e. Allegro.pas). 8)

[edit]
I'm reading about the @IncludeCode tag and @Include. I should learn how to use them as they'll help a lot to manage Allegro.pas documentation (it is huge!).  Where should be the external files?  Can we tell a search directory for them using command line options or something?

Great job!
« Last Edit: February 10, 2018, 01:42:16 pm by Ñuño_Martínez »
Are you interested in game programming? Join the Pascal Game Development community!

michalis

  • Jr. Member
  • **
  • Posts: 95
    • Homepage
Re: PasDoc 0.15.0 release
« Reply #3 on: February 10, 2018, 04:47:15 pm »
Thank you for good words!

Quote
I'm reading about the @IncludeCode tag and @Include. I should learn how to use them as they'll help a lot to manage Allegro.pas documentation (it is huge!).  Where should be the external files?  Can we tell a search directory for them using command line options or something?

Right now, the filenames you give in @includeCode and @include are resolved relative to the directory of the Pascal source file where they occurred. So, you should either keep them in the same directory, or explicitly specify another directory like @code(../docs/sample.pas) or such.

That said, it's not something set in stone:) You can submit a feature request (or patch :) ) to improve it.

If you want to move large documentation outside of the source code, you can also use https://github.com/pasdoc/pasdoc/wiki/ReadDescriptionFromFile to place the documentation in different files. You then point to the external file location on the command-line.

Ñuño_Martínez

  • Hero Member
  • *****
  • Posts: 718
    • Burdjia
Re: PasDoc 0.15.0 release
« Reply #4 on: February 12, 2018, 01:07:45 pm »
Two question (too lazy to test by myself :-[):
  • Is it possible to use "--description" more than once in the command line?
  • If I use @include/@includeCode in an external descripcion file, is the path relative to Pascal source or description file?
Are you interested in game programming? Join the Pascal Game Development community!

michalis

  • Jr. Member
  • **
  • Posts: 95
    • Homepage
Re: PasDoc 0.15.0 release
« Reply #5 on: February 13, 2018, 12:04:22 am »
Is it possible to use "--description" more than once in the command line?

Yes. All the description files are "summed together". I updated https://github.com/pasdoc/pasdoc/wiki/ReadDescriptionFromFile to mention this.

If I use @include/@includeCode in an external descripcion file, is the path relative to Pascal source or description file?

Relative to the Pascal source. Which may not be what you expect, but this was most straightforward to implement (as internally, we store the filename in which the Pascal identifier occurred; we don't store the filename in which the particular description was placed).

I improved https://github.com/pasdoc/pasdoc/wiki/IncludeCodeTag and https://github.com/pasdoc/pasdoc/wiki/IncludeTag to mention this.

Ñuño_Martínez

  • Hero Member
  • *****
  • Posts: 718
    • Burdjia
Re: PasDoc 0.15.0 release
« Reply #6 on: February 13, 2018, 12:08:38 pm »
Thanks. :)
Are you interested in game programming? Join the Pascal Game Development community!

 

Recent

Get Lazarus at SourceForge.net. Fast, secure and Free Open Source software downloads Open Hub project report for Lazarus