GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Download
  • Where To Place Comments
  • Writing Documentation
  • Advanced Features
  • Demo
  • Projects Using PasDoc
  • PasDoc vs FpDoc
  • PasDoc GUI
  • Other Tools
  • @abstract
  • @author
  • @bold, @italic
  • @br
  • @code

This view

  • Original page
  • New address

GeezerVison is showing pasdoc.github.io — @include tag

@include tag

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

  • Download

Features:

  • Where To Place Comments

  • Writing Documentation

  • Advanced Features

  • Demo

  • Projects Using PasDoc

  • PasDoc vs FpDoc

  • PasDoc GUI

  • Other Tools

Supported Tags:

  • @abstract

  • @author

  • @bold, @italic

  • @br

  • @code

  • @created, @lastmod

  • @cvs

  • @deprecated

  • @exclude

  • @html

  • @image

  • @includeCode

  • @include

  • @name, @className, @inheritedClass, @inherited

  • @shortTitle, @title, @section, @anchor

  • @latex

  • @link

  • @orderedList, @unorderedList, @definitionList, @item, @itemLabel, @itemSpacing, @itemSetNumber

  • @longCode

  • @member, @value

  • @noAutoLink, @noAutoLinkHere

  • @note, @warning

  • @param, @returns, @raises

  • @preformatted

  • @seeAlso

  • @tableOfContents

  • @table, @row, @rowHead, @cell

  • @nil, @true, @false

  • @(, @)

  • @url

Command Line:

  • Examples

  • --format:
    • --format=html
    • --format=htmlhelp
    • --format=latex
    • --format=latex2rtf
    • --format=simplexml
    • --format=php
  • --auto-abstract

  • --auto-back-comments

  • --auto-link, --auto-link-exclude

  • --cache

  • --marker, --staronly, --marker-optional

  • --define, --conditionals

  • --css, --css-based-on-bootstrap

  • --title

  • --exclude-generator

  • --external-class-hierarchy

  • --graphviz-uses, --graphviz-classes, --link-gv-uses, --link-gv-classes

  • --header, --footer

  • --html-head, --html-body-begin, --html-body-end

  • --ignore-leading

  • --ignore-marker

  • --inherited-members

  • --introduction, --conclusion, -A, --additional

  • --implicit-visibility

  • --lowercase-keywords

  • --visible-members

  • --include-creation-time

  • --include

  • --link-look

  • --markdown

  • --name

  • --no-auto-abstract

  • --no-macro

  • --language

  • --output

  • --description

  • --show-source-position, --source-url-pattern, --source-root

  • --sort

  • --spell-check, --spell-check-ignore-words

  • --use-tipue-search

  • --write-uses-list

  • @<config-file.txt>

  • --implementation-comments

Development:

  • Compiling

  • Development Snapshots

  • Release Making

Developers pages:

  • Do Di

  • Garfield Fr

  • Johannes Berg

  • Michalis Kamburelis

  • Thomas Mueller

You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.