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

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — GitHub - pasdoc/pasdoc: Documentation tool for ObjectPascal (Free Pascal, Lazarus, Delphi) source code

BranchesTags
Open more actions menu

Latest commit

 

History

2,290 Commits
2,290 Commits

Folders and files

NameName
Last commit message
Last commit date
.github
.github
 
 
img
img
 
 
lib
lib
 
 
logos
logos
 
 
man
man
 
 
old_docs
old_docs
 
 
source
source
 
 
tests
tests
 
 
www/screenshots
www/screenshots
 
 
.gitattributes
.gitattributes
 
 
.gitignore
.gitignore
 
 
ChangeLog.md
ChangeLog.md
 
 
LICENSE
LICENSE
 
 
Makefile
Makefile
 
 
README.md
README.md
 
 
pasdoc-fpc.cfg
pasdoc-fpc.cfg
 
 

Repository files navigation

PasDoc - documentation generator for Pascal source code

Introduction

PasDoc is a documentation tool for the Object Pascal code. Documentation is generated from comments found in the source code or in special "description files". Numerous output formats are supported, including HTML, LaTeX (for PDF, PS), XML and PHP.

This is a free and open source software.

Basic Usage

Put comments before the identifiers in your Pascal source code. Like this:

{ My amazing unit. This does @bold(something amazing). }
unit MyUnit;

interface

type
  { My amazing class. }
  TMyClass = class
  private
    FMyProperty: String;
  public
    { My amazing method. Sets @link(MyProperty) to 'foo'. }
    procedure MyMethod;
    { My amazing property. }
    property MyProperty: String read FMyProperty write FMyProperty;
  end;

implementation
// ...
end.

Process this source code with PasDoc, and get documentation in one of the output formats. From the command-line, you can do it like this:

mkdir -p output-dir/
pasdoc myunit.pas --format=html --output=output-dir

You can also use the GUI interface.

Support Us

If you find PasDoc useful, we appreciate your donations. This helps us to continue improving PasDoc. Michalis, maintainer of PasDoc, also makes Castle Game Engine, and you can use the same channels (like Patreon) to donate to both projects.

Complete Documentation

See the documentation on our website covering all the features of PasDoc, including the supported comment syntax, output formats, and more.

License

GNU GPL >= 2.

Copyright

  • copyright (C) 1998-2000 by Marco Schmidt
  • copyright (C) 2001-2003 by Ralf Junker [email protected]
  • Copyright (C) 2003 by Johannes Berg [email protected]
  • Copyright 2005-2026 by Michalis Kamburelis, Richard B. Winston and more contributors, see ChangeLog.md file.

About

Documentation tool for ObjectPascal (Free Pascal, Lazarus, Delphi) source code

pasdoc.github.io/

Topics

delphidocumentationdocumentation-toolfpcfreepascalhacktoberfesthtmllatexlazaruslazarus-ideobject-pascalpascal

Resources

Readme
GPL-2.0 license
Activity
Custom properties

Stars

214 stars

Watchers

29 watching

Forks

64 forks
Report repository

Releases

Sponsor this project

Packages

Used by

Contributors

Languages

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.