Details
-
Epic
-
Resolution: Unresolved
-
Not Evaluated
-
None
-
None
-
None
-
Spec generation (upstreamed)
Description
TODO: Validate the requirements if the PDF export is the way customers want to do Designer->Developer workflow.
What is required
- A documentation tool, like doxygen
- Customers want HTML export and want to edit the result later on
- Layouting should be done via WebEngine and CSS
- Should be a command line tool, decoupled from Design Studio infrastructure
Steps for up-streaming
- General Cleanup
- The Customer-specific stuff needs to be removed
- Specify what should be part of a minimal "default" specification
- A generic specification template is needed
- Create a plugin interface for the sections and the necessary build system setup
- The plugin needs to be split into a command-line tool and a Qt Creator plugin
- The means all metadata needs to be exported into folder containing metadata as JSON and image assets
- Some classes need to be refactored
- Command line tool needs to be deployed
- High initial effort but pay-off is huge because testability is superior with this setup
- As a common customer, I would expect to have a generic HTML export option in place as well