Unit 'fpmkunit' Package
[Overview][Constants][Types][Classes][Procedures and functions][Variables][Index] [#fcl]

TFPDocFormat

FPDoc documentation output formats

Declaration

Source position: fpmkunit.pp line 181

type TFPDocFormat = (

  ffHtml,

  

HTML format output

  ffHtm,

  

HTM format output

  ffXHtml,

  

XHTML format output

  ffLaTex,

  

LaTeX format output

  ffXMLStruct,

  

XML structured output

  ffChm

  

Compressed HTML Help format

);

Description

Enumeration defining the various output formats supported by the FPDoc documentation generator. Each format represents a different way to present the generated documentation.

ffHtml
generates documentation in HTML format, creating web pages that can be viewed in any web browser.
ffHtm
generates documentation in HTM format, an alternative HTML format with .htm file extension. This format provides the same functionality as HTML but uses the traditional 8.3 filename convention.
ffXHtml
generates documentation in XHTML format, a stricter XML-compliant version of HTML.
ffLaTex
generates documentation in LaTeX format, suitable for producing high-quality printed documentation. LaTeX output can be processed to create PDF, PostScript, or DVI files with professional typesetting.
ffXMLStruct
generates documentation in structured XML format, providing a machine-readable representation of the documentation data.
ffChm
generates documentation in Compressed HTML Help (CHM) format, creating Windows Help files with full-text search capabilities.

See also

TFPDocFormats

  

Set of FPDoc formats


Documentation generated on: Dec 15 2025