Integrating Qt Examples: Difference between revisions
Jump to navigation
Jump to search
AutoSpider (talk | contribs) (Add "cleanup" tag) |
(Cleanup) |
||
| (One intermediate revision by one other user not shown) | |||
| Line 1: | Line 1: | ||
{{ | {{LangSwitch}} | ||
Once you have written an example (see [[Writing Qt Examples]]) and documented it, you need to do the following things to ensure that it will work correctly within Qt's build and documentation systems: | Once you have written an example (see [[Writing Qt Examples]]) and documented it, you need to do the following things to ensure that it will work correctly within Qt's build and documentation systems: | ||
# Ensure that the example's .pro file contains the standard rules for installation. | # Ensure that the example's .pro file contains the standard rules for installation. | ||
# Add the example directory to the parent directory's .pro file. Make sure that the example compiles when ''make sub-examples'' is run. | # Add the example directory to the parent directory's .pro file. Make sure that the example compiles when ''make sub-examples'' is run. | ||
# Add documentation for the example to the ''examples/<module>/'' directory. Make sure you create a screenshot with a file name that ends in '' | # Add documentation for the example to the ''examples/<module>/'' directory. Make sure you create a screenshot with a file name that ends in '' -example.png''. | ||
The [[Qt_Documentation_Structure]] page contains the documentation structure for examples. | The [[Qt_Documentation_Structure]] page contains the documentation structure for examples. | ||
# Ensure that the example and documentation files are correctly licensed. Use existing license headers for examples and documentation and update the year accordingly. The headers are in qt5/qtbase | # Ensure that the example and documentation files are correctly licensed. Use existing license headers for examples and documentation and update the year accordingly. The headers are in qt5/qtbase | ||
# Add a link to the example documentation from overviews, the example pages, and other relevant documentation. | # Add a link to the example documentation from overviews, the example pages, and other relevant documentation. | ||
# Add the example to qtdemo by editing the ''demos/qtdemo/xml/examples.xml'' file. | # Add the example to qtdemo by editing the ''demos/qtdemo/xml/examples.xml'' file. | ||
Latest revision as of 20:07, 28 June 2015
Once you have written an example (see Writing Qt Examples) and documented it, you need to do the following things to ensure that it will work correctly within Qt's build and documentation systems:
- Ensure that the example's .pro file contains the standard rules for installation.
- Add the example directory to the parent directory's .pro file. Make sure that the example compiles when make sub-examples is run.
- Add documentation for the example to the examples/<module>/ directory. Make sure you create a screenshot with a file name that ends in -example.png.
The Qt_Documentation_Structure page contains the documentation structure for examples.
- Ensure that the example and documentation files are correctly licensed. Use existing license headers for examples and documentation and update the year accordingly. The headers are in qt5/qtbase
- Add a link to the example documentation from overviews, the example pages, and other relevant documentation.
- Add the example to qtdemo by editing the demos/qtdemo/xml/examples.xml file.