--include command-line option

Just like a Pascal compiler, PasDoc understands $include compiler directive and reads include files. It searches for include files in the current directory and in all directories given with the --include CommandLine option. Examples:

pasdoc --include c:\mysources\include --include c:\3rdparty\somelib\include ...

pasdoc --include c:\mysources\include;c:\3rdparty\somelib\include ...

As shown in the first example it is possible to specify multiple --include options.

You can also specify multiple include paths per --include directive, separating them with the platform’s path separator (which is ':' on Unix and ';' on Windows) as shown in the second example. So both examples above (and the two below) are equivalent.

Another example when running under Unix:

pasdoc --include /home/me/include --include /usr/local/pascal/include ...

pasdoc --include /home/me/include:/usr/local/pascal/include ...

The short form of --include option is -I (upper case i).

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