Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[mbeddr.doc] Add support for documentation that includes mbeddr.doc paragraphs/images #2358

Open
HeikoBecker opened this issue Jan 10, 2024 · 0 comments
Labels

Comments

@HeikoBecker
Copy link
Member

Currently, a user of mbeddr.doc cannot use images or other mbeddr.doc elements to write documentation in-place with this infrastructure.

The IDocumentable interface allows to attach a single paragraph documentation via the addDocumentation intention (node url, node attributee)

Ideally, mbeddr.doc provides a new interface, e.g., IHaveRichDocumentation, that supports documentation similar to the documentation written in mbeddr.doc sections (i.e. multiple paragraphs to support images and the likes).

The new interface should be interoperable with the old interface. If the intions and documentation of one is shown, the documentation and intentions of the other should not be available. For existing cases, an error/warning should be raised.

This functionality should also be integrated with the documentation viewer from the mbeddr.doc aspect which currently checks only for the documentation from the IDocumentable.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants