Child pages
  • Home
Skip to end of metadata
Go to start of metadata

FarCry Documentation Plugin (farcrydoc)

FarCry Component Documentation

Icon

The farcrydoc plugin is used to generate the static component documentation for the FarCry Framework. For details of libs, formtools, custom tags and more you can link direct to the latest export here:

http://docs.farcrycore.org/

Overview

Icon

FarCry Doc Plugin requires a minimum of FarCry v4.x to function.

FarCry Documentation plugin provides extensive documentation on framework, plugin and project based components. An awesome utility for FarCry developers that dynamically introspects your installation to extract oodles of information.

Download

You can grab the latest code base from the FarCry subversion repository:

  • v1.0.1 (suitable for FarCry v5.x+) Download or

  • trunk (under develoment, suitable for FarCry 6.x)

Installation

Checkout or unzip the plugin to the ./plugins folder for your installation. Make sure the directory is called farcrydoc.

5,0,x or 6,0,x Installation

Update the plugin list in your project's ./www/farcryConstructor.cfm file.

Example ./www/farcryConstructor.cfm

4,0,x Installation

Add farcryverity to your plugin list in the farcryinit tag of your project's Application.cfm:

./www/Application.cfm

Configuration

Check the ADMIN > COAPI utilities for any undeployed types & then restart the application.

Updating Documentation

Icon

Everything is extracted from component metadata, and comments added to the code base in a distinct style: https://farcry.jira.com/wiki/display/FCCORE/Auto-Documentation