DelphiDox

Documenting Delphi-Sources with Doxygen's special ALIASES.

This little tutorial offers a basic solution to plainly document Delphi source code with a couple of Doxygen ALIASES, and based on the Delphi's ability to create .hpp header files.

Note

• Tested with Delphi 10.3.3 (Rio), but should work with older versions, too; the ability to create .hpp headers is builtin since Delphi 6(!).
• Tested with Doxygen 1.8.18, but should work also with older versions.

Author

Dipl. Inf. Thomas Schneider

Copyright

Dipl. Inf. Thomas Schneider (c) 2020

Date

9.5.2020

Homepage: https://sys-thos.de

eMail: thomas.schneider@sys-thos.de

Download (zipped Documentation & Example)

---

Quickstart

The simplest way is to copy the whole example project and adapt it to your Delphi project:

• example project directory tree & Delphi sources.
• example project documentation.

Alternatively you can configure at your own (nevertheless it may be useful to create the directory structure like the example project end especially copy all the files from Doxygen configuration directory ):

• Add some Delphi configuration options:
  Preparing the Delphi Project :
  • Create a new build configuration for Doxygen
  • Set C++ configuration options
  • Optional: Set post build event to automatically generate the documentation

    Attention

    Don't forget to adjust the path to your Doxygen installation in file DelphiDox.bat!

• Insert some header lines to each Delphi unit:
  Delphi unit structure: Summary
• Add or merge some lines to the Doxygen configuration file to be able to insert Delphi / C++Builder declarations into the documentation:
  Required configuration settings
• And then: Document the code

---