Files

Eike Ziller 4b3a746332 CMake build: Fix remaining issues with Devel package

On Linux (and Windows) we should not create toplevel files (README.md
etc) or directories (doc/, scripts/ etc).

On macOS, move the whole Devel package contents into the app bundle,
because that is installed toplevel in the Qt installers, and we
shouldn't even create include/, lib/ or any other directory at the
toplevel at all.

Since the prefix path must now point to the Resources folder inside the
app bundle, adapt build_plugin.py to also accept --qtc-path pointing to
the app bundle (Qt Creator.app) itself, and also to the app bundles
parent directory. Adapt the Qt Creator plugin project template
similarly.

Task-number: QTCREATORBUG-25414
Fixes: QTCREATORBUG-25415
Change-Id: Ic756237fb920b54b1ec95d076649ad947b39a7e8
Reviewed-by: Cristian Adam <cristian.adam@qt.io>

2021-04-06 10:59:27 +00:00

config

Doc: Describe using Qt Bridge for Figma

2020-12-11 16:26:06 +00:00

qtcreator

Doc: Add info about finding type alias definitions

2021-04-06 06:18:26 +00:00

qtcreatordev

Doc: Use version independent Qt link

2020-12-10 10:48:25 +00:00

qtdesignstudio

Doc: Update info about Figma export options

2021-04-01 07:25:08 +00:00

titlecase

Strip BOM from files

2015-10-01 10:51:10 +00:00

CMakeLists.txt

CMake build: Fix remaining issues with Devel package

2021-04-06 10:59:27 +00:00

doc_targets.pri

Fix qdoc call after it moved to LLVM/Clang

2020-02-17 15:45:48 +00:00

doc.pri

Make documentation part of branding

2020-02-19 06:57:53 +00:00

doc.qbs

Adapt qbs build to doc changes

2020-01-27 12:33:51 +00:00

fixnavi.pl

make fixnavi actually work with examples

2017-03-13 12:27:08 +00:00

README.md

Doc: Update guidelines for writing Qt Creator documentation

2020-04-02 07:07:52 +00:00

runframework.dia

Initial import

2008-12-02 12:01:29 +01:00

README.md

Documentation Projects in This Repository

The qtcreator repository contains the sources for building the following documents:

Qt Creator Manual
Extending Qt Creator Manual
Qt Design Studio Manual

The sources for each project are stored in the following subfolders of the doc folder:

qtcreator
qtcreatordev
qtdesignstudio

For more information, see: Writing Documentation

The Qt Design Studio Manual is based on the Qt Creator Manual, with additional topics. For more information, see the README file in the qtdesignstudio subfolder.

The Extending Qt Creator Manual has its own sources. In addition, it pulls in API reference documentation from the Qt Creator source files.

QDoc

All the documents are built when you enter make docs on Linux or macOS or nmake docs on Windows.

Since Qt Creator 4.12, you need to use QDoc Qt 5.14 or later to build the docs. While building with QDoc from Qt 5.11 or later technically works, the Qt Creator Manual and Qt Design Studio Manual link to newer Qt modules, which means link errors will be printed.

Please make the docs before submitting code changes to make sure that you do not introduce new QDoc warnings.

While working on changes that introduce lots of warnings about missing API documentation, for example, you can enter an option to write the doc errors to the log. This helps make doc builds faster until you have fixed the errors. For example, on Windows enter nmake docs 2> log.txt.