https://github.com/lukaszcz/srcdoc
Documentation generator a la doxygen for Free Pascal and Delphi.
https://github.com/lukaszcz/srcdoc
delphi documentation doxygen pascal source-code
Last synced: 3 months ago
JSON representation
Documentation generator a la doxygen for Free Pascal and Delphi.
- Host: GitHub
- URL: https://github.com/lukaszcz/srcdoc
- Owner: lukaszcz
- License: gpl-2.0
- Created: 2021-09-26T09:20:31.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-07-13T11:43:12.000Z (almost 2 years ago)
- Last Synced: 2025-01-09T02:34:05.910Z (over 1 year ago)
- Topics: delphi, documentation, doxygen, pascal, source-code
- Language: Pascal
- Homepage:
- Size: 255 KB
- Stars: 4
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
SrcDoc is a documentation generator a la doxygen for Free Pascal and Delphi. It parses comments in Pascal sources and generates a hyperlinked source code documentation. In contrast to other similar programs, the comments need not even be formatted.
Features
--------
* Supports almost all Object Pascal syntax.
* Generation of class and interface tree hierarchies.
* Generation of a symbol index.
* Comment autoformatting ("beautification").
Requirements
------------
* Linux
* [Free Pascal](https://www.freepascal.org)
* [PascalAdt](https://pascaladt.github.io) library version 1.0.2
Installation and usage
----------------------
* Compilation: `make`
* Installation: `./install.sh`
Documentation and examples
--------------------------
SrcDoc manual is available online: [https://lukaszcz.github.io/srcdoc-docs/](https://lukaszcz.github.io/srcdoc-docs/).
Some output examples:
* [SrcDoc source documentation](https://lukaszcz.github.io/srcdoc-docs-dev/)
* [PascalAdt API reference](https://pascaladt.github.io/pascaladt-docs/)
Copyright and license
---------------------
Copyright (C) 2005-2024 by Lukasz Czajka.
Distributed under the terms of GPL 2. See [LICENSE](LICENSE).