Documentation hyperlinks error

[the-Arioch]

because it should be CREF not HREF

see https://github.com/Code4Delphi/help-insight-delphi/blob/master/README.en.md

see also

i'll create an MR next week

[salvadordf]

Embarcadero made an incomplete implementation of the "XML comment format" used in other languages and the "see" element is not currently supporting the "href" attribute which should produce a clickable link.

I use the pasdoc project and it has some issues with the "see" attributes. If I try to use "href" then is shows the URL but if I try to use "cref" then the utility can't recognize the URL or crashes if I encode it.

If you know of any other open source project to parse xml code comments into help files in html, chm or hlp format, please let me know.

[the-Arioch]

if i find time i would look into it, also AFAIR PasDoc is mantained by the same German guy who mantained Castle Game Engine and he was very responsive with CGE. When i was learning CGE he was coming back in about a week for every question give or take. Granted, PasDoc is not a priority for him, but jsut a tool to make CGE better.

this is a good link at MSDN, but is it granted that DocInsight claims XmlDoc compativility? AFAIR DocInsight was a third-party that Embarcadero licensed (a limited edition) to bundle with Delphi. Some years ago i tried a trial from the original vendor, but i no longer remember who he was.

OTOH this probably does not matter much, since you ended up with PasDoc it might be of little relevance what Microsoft tools do support. Frankly, i do not think XML format per se is of importance here. The other reasons should be of more practical value, like CI and output formats.

I use the pasdoc project and

i know, my last screenshot exactly is the PasDoc sources, github trunk. What version of PasDoc did you use that you say it was crashing?

[salvadordf]

I use the latest code available at GitHub, not the latest "release".

When I try using cref with a normal URL the html shows "UNKNOWN" instead of the original XML with the URL and the text.
I also tried cref with an encoded URL, which is incorrect, and the utility shows an error message and it stops responding.

[the-Arioch]

i just compiled pasdoc with Delphi XE 10.2.0 (we do not have any further version) and... i'm lost what to do next :-)

PasDoc 0.16.0-snapshot [2021-02-07|DELPHI (Compiler Version 32,0)|MSWindows|32]
Documentation generator for Pascal source

This is free software; see the source for copying conditions.  There is NO
warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

Usage: pasdoc.exe [options] [files]
Valid options are:
  @<path to config file>      Read options from specified file and insert them
                              at current position. File must contain one option
                              per line.

Could you put your command line for pasdoc into git, as a bat-file or as a config file for pasdoc ?

[the-Arioch]

Perhaps the most CI-ish way would be to have a bat-file for PasDoc, then to call that bat-file from post-build events of the package DPROJ files