Reviewed: https://reviews.mahara.org/c/mahara/+/12093 Committed: https://git.mahara.org/mahara/mahara/commit/7d2a31448a756629607c9fc64236fec3a4ef9d3e Submitter: "Robert Lyon <[email protected]>" Branch: main
commit 7d2a31448a756629607c9fc64236fec3a4ef9d3e Author: Doris Tam <[email protected]> Date: Fri Jun 4 15:44:05 2021 +1200 Bug 1949919: Update documentation in the htdocs/artefact/file directory There are too many issues here due to PHPDocumentor only being able to see it's direct parent i.e. can't see doc for interfaces that have been implemented by a middle abstract class. // Helper interface to hold the PluginArtefact's abstract static functions interface IPluginArtefact { /** * This function returns a list of classnames * of artefact types this plugin provides. * @abstract * @return array */ public static function get_artefact_types(); } // Helper interface to hold the Plugin class's abstract static functions interface IPlugin {} // Base class for all plugintypes. abstract class Plugin implements IPlugin {} // Plugin artefact file class - this abstract class can implement some or all of what // is declared in the interface IPluginArtefact and declare new functions too. // You can ignore Plugin here as it's not in this context abstract class PluginArtefact extends Plugin implements IPluginArtefact {} // This real class takes all of what is given in IPluginArtefact and PluginArtefact class PluginArtefactFile extends PluginArtefact {} // example... class PluginArtefactFile { // ... {@inheritDoc} public static function get_artefact_types() {} // ... } Change-Id: If23222ea955397030b8156e1aae49043eb9d680c -- You received this bug notification because you are a member of Mahara Contributors, which is subscribed to Mahara. Matching subscriptions: mahara-contributors https://bugs.launchpad.net/bugs/1949919 Title: Update documentation in the htdocs/artefact/file directory Status in Mahara: Fix Committed Bug description: Update documentation in the htdocs/artefact/file directory To manage notifications about this bug go to: https://bugs.launchpad.net/mahara/+bug/1949919/+subscriptions _______________________________________________ Mailing list: https://launchpad.net/~mahara-contributors Post to : [email protected] Unsubscribe : https://launchpad.net/~mahara-contributors More help : https://help.launchpad.net/ListHelp
