Sign in Join
FPDoc Onlineexperiment

TSources.AddExample function

Member of TSourcespublicIn unit fpMkUnit

Adds example sources to the collection

Declaration

pascal
function AddExample(const AFiles: string): TSource
function AddExample(const AFiles: string; AInstallSourcePath: string)
: TSource

Arguments

AFiles

List of example files to add

AInstallSourcePath

Installation path for example sources

Function result

Newly created example source item

Description

Creates and adds a new example source entry that specifies example program files to be installed in the examples directory. Examples demonstrate usage of the package functionality and serve as learning resources.

Example files help users understand how to properly use the package APIs and provide working code samples for common use cases.

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