IncludeTag

Michalis Kamburelis edited this page Feb 12, 2018 · 4 revisions

You can use @include tag to include text from another file into a description. For example:

{ This is some procedure.
  @include(some_procedure_large_docs.txt) }
procedure SomeProcedure;

Inside file some_procedure_large_docs.txt you can use all normal pasdoc features, @-tags etc. (see WritingDocumentation).

The @include tag may be handy when documentation for given item is so large that it’s more comfortable to keep it in entirely separate file. Or when you want to include some documentation text more than once --- because you can @include the same file as many times as you wish.

The filename (some_procedure_large_docs.txt in the example above) is relative to the Pascal source file defining this identifier (SomeProcedure in the example above). You can use something like @includeCode(../docs/some_procedure_large_docs.txt) to refer to a different directory.

PasDoc, documentation generator for Pascal:
Features:
Supported Tags:
Command Line:
Development:
Developers pages:
Clone this wiki locally
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.