Sign in Join
FPDoc Onlineexperiment

TTargets.AddExampleUnit function

Member of TTargetspublicIn unit fpMkUnit

Adds an example unit target to the collection

Declaration

pascal
function AddExampleUnit(const AUnitName: string): TTarget
function AddExampleUnit(const AUnitName: string; const OSes: TOSes)
: TTarget
function AddExampleUnit(const AUnitName: string; const CPUs: TCPUS; 
 const OSes: TOSes): TTarget

Arguments

AUnitName

Unit name for the example

OSes

Target operating systems for example unit

CPUs

Target CPU architectures for example unit

Function result

Newly created example unit target

Description

Creates and adds a new example unit target that demonstrates usage patterns and serves as sample code for package functionality.

Example units are typically installed separately from main package units and provide documentation through working code examples.

An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.