[fpc-pascal] Can fpdoc insert macro values or compiler version information?

Graeme Geldenhuys mailinglists at geldenhuys.co.uk
Wed May 3 18:08:29 CEST 2017


Hi,

Does FPDOC have the ability to inject the compiler version into RTL and
FCL documentation? Something like FPC's macro variables or something.
eg: in the RTL Package Overview contents?

eg:
  Inside the "Description" content of this page:

    https://www.freepascal.org/docs-html/rtl/


The reason I ask, is because some output formats of fpdoc doesn't
contain the FPC version it relates to. In fact, only the PDF
documention, and I think that is accomplished manually via a LaTeX template.

If I look at the content of the above URL, no version number is
mentioned. If I look at INF or CHM generated documentation of the RTL or
FCL, the same problem exists. One can't determine which FPC version
those docs relate too.

Thinking about this a bit more, if fpdoc had (or has) the ability to do
macro variable replacements when generating documentation, macro values
or definitions could be passed via the command line, and such
information inserted in all documentation of various libraries and
frameworks that use fpdoc to generate class documentation. eg: the
version of the fpGUI's INF file, or the version of the LCL.chm file etc.

Regards,
  Graeme

-- 
fpGUI Toolkit - a cross-platform GUI toolkit using Free Pascal
http://fpgui.sourceforge.net/

My public PGP key:  http://tinyurl.com/graeme-pgp



More information about the fpc-pascal mailing list