IncludeTag

Michalis Kamburelis edited this page Jan 7, 2017 · 3 revisions
Clone this wiki locally

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.