const mixincamembert::PluginDocs

camembert::PluginDocs

PluginDoc Documentation provider associated with a plugin

dis

Source

virtual Str dis()

User friendly dsplay name

findSrc

Source

virtual FileItem? findSrc(Str query)

Return a FileItem for the document matching the current source file (if known) Query wil be what's in the helPane serach box, ie "fwt::Combo#make" (not prefixed by plugin name)

html

Source

abstract Str html(WebReq req, Str query, MatchKind matchKind)

Return html for a given path Note, the query will be prefixed with the plugin name for example /fantom/fwt::Button

icon

Source

abstract Image? icon()

An icon for that plugin / language documentation

pluginName

Source

abstract Str pluginName()

name of the plugin responsible