Integrating Qt Examples: Difference between revisions

From Qt Wiki
Jump to navigation Jump to search
No edit summary
 
(Cleanup)
 
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
'''English''' [[Integrating-Qt-Examples Russian|Русский]] [[Integrating-Qt-Examples-Spanish|Spanish]] [[Integrating-Qt-Examples Italian|Italian]] [[Integrating-Qt-Examples-SimplifiedChinese|简体中文]]
{{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:


=Integrating Qt Examples=
# 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.
Once you have written an example (see [[Writing-Qt-Examples|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:
# 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’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/&lt;module&gt;/'' directory. Make sure you create a screenshot with a file name that ends in '' -example.png''.<br /> The [[Qt Documentation Structure|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.
===Categories:===
* [[:Category:Developing-Qt|Developing Qt]]
** [[:Category:Developing-Qt::Documentation|Documentation]]

Latest revision as of 20:07, 28 June 2015

En Ar Bg De El Es Fa Fi Fr Hi Hu It Ja Kn Ko Ms Nl Pl Pt Ru Sq Th Tr Uk Zh

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:

  1. Ensure that the example's .pro file contains the standard rules for installation.
  2. Add the example directory to the parent directory's .pro file. Make sure that the example compiles when make sub-examples is run.
  3. 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.

  1. 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
  2. Add a link to the example documentation from overviews, the example pages, and other relevant documentation.
  3. Add the example to qtdemo by editing the demos/qtdemo/xml/examples.xml file.
Retrieved from "https://wiki.qt.io/index.php?title=Integrating_Qt_Examples&oldid=18592"