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

  • abstract
  • @tags
  • Introduction and conclusion
  • --description
  • --implementation-comments
  • comment markers
  • --auto-link
  • --css or --css-based-on-bootstrap
  • inherited members
  • --visible-members
  • --use-tipue-search
  • --language
  • GraphVizSupport
  • Spell checking

This view

  • Original page
  • New address

GeezerVison is showing pasdoc.github.io — Advanced Features

Advanced Features

Table of Contents
  • 1. Input
  • 2. Output
  • 3. More

Some important non-obvious PasDoc features:

1. Input

  • We automatically treat the 1st sentence of the description as an abstract. So make sure it "stands on its own" and is a good short description of the item. You can also explicitly specify the abstract using @abstract tag.

  • You can write entire pages using pasdoc syntax, with all supported @tags. This way you can use pasdoc like a simple document creation tool. See the Introduction and conclusion documentation.

  • By default documentation is read from the source code comments. But you can also write it in separate external files: see the --description command-line option.

  • By default we consider only comments in the interface section of the unit. But you can enable parsing also the implementation sections, and using comments from it, using the --implementation-comments option.

  • By default every comment before an identifier is treated as a documentation. But you can limit this with arbitrary comment markers.

  • --auto-link command-line option allows you to avoid writing so many @link tags. Identifiers will be automatically turned into links.

  • Markdown support for emphasis, lists, code blocks etc.

2. Output

  • Our HTML output has a modern, mobile-friendly design based on Bootstrap. You can customize it using --css or --css-based-on-bootstrap command-line options. You can also add your own HTML code to the output using --html-head, --html-body-begin and --html-body-end command-line options.

  • The documentation of each class can also include inherited members.

  • The documentation of each class can have toggable (using checkboxes in HTML) visibility e.g. for protected members. See --visible-members command-line option.

  • The documentation can point to the source code (file, line number) where given item is declared. It can even link to the online repository (e.g. GitHub) which is a great way to link people from your docs to your code. See the --show-source-position, --source-url-pattern, --source-root command-line options.

  • You can easily add a search box to your documentation, just pass --use-tipue-search command-line option.

  • The documentation can be localized to many languages, see the --language command-line option.

  • GraphVizSupport allows PasDoc to easily incorporate classes inheritance and unit dependency graphs in the documentation.

  • Spell checking.

3. More

  • Caching for faster generation of documentation.

  • See also comparison of PasDoc with FpDoc (another open-source Pascal documentation tool).

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 01402520 — 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.