new IPF output writer for FPDoc
Original Reporter info from Mantis: ggeldenhuys
-
Reporter name: Graeme Geldenhuys
Original Reporter info from Mantis: ggeldenhuys
- Reporter name: Graeme Geldenhuys
Description:
This patch contains the following changes:
* Patch with new linear based IPF writer
* patch for Interfaces Overview in all Linear writers
* patch with new Linear Writer specific parameter to control
if linked documentation should be duplicated or not.
new parameter is: --duplinkeddoc
Default is that linked docs are not duplicated.
* patch for fixing minor spelling mistakes in fpdoc
* patch to not create a section Errors if there isn't actually
any specific documentation for errors. makeskel generates error
nodes but most don't have any items. This caused an Errors title
in the docs, but with no content.
* patch to fix SeeAlso section in Linear writer. It never output
the custom text, but always the node link as text.
* new features for linear writer that could be overridden in
descendants.
- marked some protected methods as virtual so it can be overridden
in descendants for customization.
- new section for listing Types found in a unit. Default it does nothing,
except for in IPF writer.
- new section for listing Variables found in a unit. Default it does nothing,
except for in IPF writer.
- new section for listing Constants found in a unit. Default it does nothing,
except for in IPF writer.
* SeeAlso items were never written in the Class Overview section.
Instructions to apply this patch.
-------------------------------
- Unpack the patch to root FPC Source directory.
- patch -p 1 < fpdoc_ipf_writer.patch
- Move dw_ipflin.pas from root FPC Source directory into utils/fpdoc/
- Delete the old IPF unit: dw_ipf.pp
Mantis conversion info:
- Mantis ID: 17191
- OS: Ubuntu Linux
- OS Build: 10.04
- Platform: x86_64
- Version: 2.5.1
- Fixed in version: 2.4.4
- Fixed in revision: 16370 (#ecb59a09)