| Freevo Plugin Writing HOWTO: Writing your own plugins for Freevo | ||
|---|---|---|
| Prev | Chapter 4. Notes for writing a plugin | Next |
You should not forget to document the plugin. Freevo can scan all available plugins by calling the plugins helper:
-> freevo plugins -l <list of plugins> -> freevo plugins -i audio.playlist Name: audio.playlist Type: ItemPlugin File: src/audio/plugins/playlist.py Description: <...>This documentation comes directly from the python source code. Use the Python docstring to document the plugin class. The first line will be used to show the short information for -l, the hole text will be used for -i.
Example:
import plugin
class MyPlugin(plugin.Plugin):
"""
This is a short description
And here should be a long description how this plugin works,
how to activate it and what settings the user needs to add
to the local_conf.py
"""
def __init__(self):
pass