Bug 481886 - Plugin system documentation
Summary: Plugin system documentation
Status: REPORTED
Alias: None
Product: konsole
Classification: Applications
Component: plugins (show other bugs)
Version: 24.01.95
Platform: unspecified Linux
: NOR wishlist
Target Milestone: ---
Assignee: Konsole Developer
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2024-02-27 10:10 UTC by gudvinr+kde
Modified: 2024-02-28 05:53 UTC (History)
1 user (show)

See Also:
Latest Commit:
Version Fixed In:
Sentry Crash Report:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description gudvinr+kde 2024-02-27 10:10:53 UTC
Currently, there are 2 built-in plugins in Konsole.
But there's no documentation on how plugin system works.

Using plugin source code is one way to get an idea of how plugin API works, but generally speaking, plugin developers don't (and shouldn't) know how app itsellf works. API should define boundary and be descriptive so people could write plugin without diving too deep into app internals.

So, I am suggesting at least adding README file in konsole/src/pluginsystem or konsole/doc/plugins, etc so one could refer to that.