Skip to content

Add plugin class diagram and README reference#229

Merged
njlane314 merged 1 commit intomainfrom
codex/create-plugin-class-diagram-in-docs-kc6um8
Sep 3, 2025
Merged

Add plugin class diagram and README reference#229
njlane314 merged 1 commit intomainfrom
codex/create-plugin-class-diagram-in-docs-kc6um8

Conversation

@njlane314
Copy link
Copy Markdown
Owner

Summary

  • Document plug-in interfaces and managers in a new PlantUML diagram
  • Reference the plug-in architecture diagram in the README

Testing

  • ctest --output-on-failure (no tests found)

https://chatgpt.com/codex/tasks/task_e_68b87af2f73c832ea4501ca04dcc55b0

@njlane314 njlane314 merged commit fdb1fd0 into main Sep 3, 2025
1 check passed
Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Codex Review: Here are some suggestions.

interface IAnalysisPlugin {
+onInitialisation()
+onEvent()
+onFinalisation()
}
class AnalysisPluginManager {
+register()
}
interface IPlotPlugin {
+run()
}
class PlotPluginManager {

[P1] Align diagram with real plugin APIs

The new PlantUML diagram depicts IAnalysisPlugin exposing only onInitialisation, onEvent, and onFinalisation and both plugin managers having a single register() entry point. In the actual headers (libplug/IAnalysisPlugin.h and the manager classes) the required callbacks are onInitialisation, onPreSampleProcessing, onPostSampleProcessing, and onFinalisation, and managers expose loadPlugins() plus various notify*/run operations. Anyone implementing a plug‑in from this diagram will target non‑existent methods and miss mandatory ones, leading to build failures and misaligned documentation. Please update the diagram (and the README reference implicitly created) to mirror the real API surface.


Reply with @codex fix comments to fix any unresolved comments.

About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you open a pull request for review, mark a draft as ready, or comment "@codex review". If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex fix this CI failure" or "@codex address that feedback".

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant