Presently the PHP docs for the plugin are very sparse - we need to go through and add meaningful/helpful phpdocs to the entire plugin at some point.
This will cause conflicts likely with other work so we should probably organise a time to do this, or organise the efforts here.