General documentation

DocInsight
1

Is it possible to add a tag for general documentation not connected to any datatype, function or procedure in the code but still accessable in Documantation Explorer and the exported documentation?

Regards

2

We’re going to introduce Markdown-based help authoring (with some extensions). Is this what you had in mind? (No plan for XML based topics)

We will also consider supporting inline Markdown-based documentation comments in source code alongside XML doc comments. This functionality will be available in both DocInsight and JetPascal, though it isn’t supported by Delphi’s built-in Code Insight.

3

I was hoping for a XML-based topic since I’m not that familiar with the Markdown-based documentation.
One may get around this by dummy-declarations in the code on which I hook the documentation but I’m afraid that it will be confusing for future developers. Do you have any suggestions on how to make a dummy-declaration to be self explained?

Regards

4

I’ve seen a similar approach in the Rust ecosystem. It’s still unclear what these documentation blocks are for and how they’re consumed, but a few ideas come to mind:

  • Place them in dedicated “dummy” units within the same folder if possible
  • Add conditional defines (e.g., a DOC build mode)
  • Use a consistent naming convention

It would be helpful if you could share a few concrete examples—we might find inspiration for new features.