Discussions related to Visual Prolog
sbishop61
Posts: 17
Joined: 9 May 2021 9:55

Documenting Projects

Post by sbishop61 »

Please excuse me if I have missed something obvious.
How do you generate documentation, such as a .chm and/or other types of helpfile, from a project?
ProDoc is no longer part of the download. Is there another tool, program or option?
TIA
User avatar
Thomas Linder Puls
VIP Member
Posts: 1471
Joined: 28 Feb 2000 0:01

Re: Documenting Projects

Post by Thomas Linder Puls »

Well the truth is that we have a documentation problem.

Microsoft doesn't really support .chm files anymore. And I find the reader and its features to be really old-fashioned in many ways.

In the coming releases much documentation will be handled directly in the IDE without involving any additional tools. This will automatically handle the packages you have in your project including your own packages.

The downside is that there is no documentation for packages which are not in your project. And therefore there is no documentation for the entire PFC. And that is a problem, because how do you figure out what to use, if you have to use it before you can read about it.

I don't know if we will find a good solution before next release or if we will use ProDoc once more. ProDoc is however also deleted in our version control system (but being in a version control system, we can of course revive it again).
Regards Thomas Linder Puls
PDC