Skip to content

Template for function documentation

Yoann Gini edited this page Nov 2, 2017 · 4 revisions

This page is 100% useless, it's used only as a copy/paste template when writing documentation for each function, to keep a coherent global documentation

Function description

Goal

Describe the goal of the function

Settings

The settings dictionary contain all informations you can set to use this function. Here is a description of each.

Key Type Description
title Translatable string (see: Label translation) Item's title shown in the menu

Sample settings

<key>title</key>
<dict>
	<key>en</key>
	<string>Self-Service</string>
	<key>fr</key>
	<string>Libre-service</string>
</dict>

More informations

Main implementation

The main implementation of this function is made in the XYZ plugin from the main project.