If you'd like to make your plugin available to the public for use in their own projects, there are a few tips and guidelines you can follow. In the following section, we will obey, as much as we can, MooTools standard documentation. Though there isn't an official standard method for documentation yet, we can use the official MooTools docs and coding styles in MooTools More plugin so that our documentation will be familiar to MooTools developers, making it easy for them to understand and learn how to implement our work.
At the top of ImageCaption.js
, we should put some meta information about our plugin so that people studying its working can know a little bit more about it. In MooTools More plugin, here is the format of this comment block.
Script: Plugin file name Brief description of the plugin License: Licensing type and copyright information Authors: FirstName-1 LastName-1 - Website URL FirstName-2 LastName-2 - Website...