Thank you for good words!
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.