Commit Graph

28 Commits

Author SHA1 Message Date
Kai Koehne
33487984b9 Doc: Use version independent Qt link
or use direct links where possible.

Change-Id: I00d559ad53a95caf91c39985bd9fb5ea99f9aed7
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2020-12-10 10:48:25 +00:00
Leena Miettinen
a45689f85c Doc: Update instructions for using the \youtube macro
We needed a workaround to make this work in Qt Creator
and Qt Design Studio help mode.

Change-Id: I9b66fe91a5faa07366375a886a9f99352629945d
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
2020-12-09 14:19:23 +00:00
hjk
7e8c212c1a Coding style: Remove outdated recommendation of foreach()
Change-Id: I01eadfdbefededf3b71df492a0e29abdd3a3a93f
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2020-12-07 08:31:33 +00:00
Leena Miettinen
0c29e50353 Doc: Describe building docs with CMake and using the online style
You can now use CMake to build docs.

You also have an option to use the online style, which
enables you to check how the docs will look after release.

Change-Id: I63f573a58a2daf3aa05a2f0dd57f33f859e25bc2
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2020-12-03 11:53:24 +00:00
Leena Miettinen
bd17dd445b Doc: Add instructions for using the \youtube macro
The macro shows a thumbnail with a play button to start the
video.

Change-Id: If4dcddfbdbc40e795f4306e83ede43187dd2439c
Reviewed-by: Johanna Vanhatapio <johanna.vanhatapio@qt.io>
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2020-11-30 10:12:00 +00:00
Leena Miettinen
2e1eed1945 Doc: Add list to words to ignore for automatic linking
Change-Id: Idfa50889deeff64a8d97bfbb5deaf4c86a32e2bf
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
2020-09-09 12:45:19 +00:00
hjk
361b80cb9b ExtensionSystem: Remove PluginSpec::isHiddenByDefault
Not used anymore.

Change-Id: Ic73ba3024b9e6157ff044cb23450fc9dad3c4c02
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2020-06-16 09:08:36 +00:00
Eike Ziller
1d3d2b5311 Add some documentation about distributing plugins
Change-Id: I02eff822105a4c98575f745bb0f4d222afb0bb73
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Reviewed-by: Alessandro Portale <alessandro.portale@qt.io>
2020-06-03 08:39:26 +00:00
Leena Miettinen
45b96d12e5 Doc: Describe writing docs for independent plugins
Plugins that reside in their own repositories need their
own documentation.

Change-Id: I97ff5b2b6788c6dd90364117e842dcdfd63085b5
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2020-05-28 07:42:04 +00:00
Eike Ziller
6d97c1fcb1 Unregister deleted IContext objects automatically
Change-Id: I7b84c02c8fe1e7201431116e3d993792370fb942
Reviewed-by: hjk <hjk@qt.io>
2020-05-27 06:54:54 +00:00
Eike Ziller
e7b319fbc1 Doc: Fix naming of .index files
Qt Creator Manual and Extending Qt Creator had the same project name,
and therefore the same index file name.
Also qdoc's "depends" configuration requires the index file to have
the same name as the directory.
Adapt the project names accordingly.

Change-Id: Ie1ec8ede360e19e3ffd5c7dbea44344f0a631f68
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2020-05-25 08:50:54 +00:00
Eike Ziller
8383ca777f Add some documentation on action manager and commands
Change-Id: I03d8292120b30973155248471b12d1627536fb39
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2020-04-20 08:12:34 +00:00
Eike Ziller
708f84cce8 Doc: Fix style for menu hierarchies
Use \uicontrol for the individual components individually

Change-Id: Idf62db7c37e94a55a988792f13aaa8c49cb1ac07
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2020-04-03 06:10:16 +00:00
Eike Ziller
3a8505fcaf Fix link to documentation on writing highlighting files
Change-Id: I374219b03d94279ca9902567294ff4e49b8ad17a
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2020-04-02 12:51:08 +00:00
Leena Miettinen
6741eb9293 Doc: Update guidelines for writing Qt Creator documentation
- Include information about writing Qt Design Studio Manual
  from its README file
- Update information about building the docs

Change-Id: Iaaff47ca3f07c859aa726e7e7f571042a8aadd48
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2020-04-02 07:07:52 +00:00
Leena Miettinen
e0d38ab353 Doc: Update instructions for creating plugins
Fixes: QTCREATORBUG-23701
Change-Id: I8e5569512eee87b18ddaeedde87122015e69b821
Reviewed-by: David Schulz <david.schulz@qt.io>
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2020-03-17 08:34:24 +00:00
Leena Miettinen
ac26d3bab9 Doc: Add Core:: namespace to \fn commands
To suppress QDoc warnings.

Task-number: QTCREATORBUG-23620
Change-Id: I4e5c633e7a0066f892f3247c28dac055557e68da
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2020-02-25 13:37:46 +00:00
Leena Miettinen
98e940c9b3 Doc: Display Core plugin classes in the API Reference
Task-number: QTCREATORBUG-23620
Change-Id: I64b3fc9ebd9ec140a28a5fbb2f70961086821ed2
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2020-02-25 13:37:30 +00:00
Leena Miettinen
45a575c218 Doc: Fix QDoc warnings in Core plugin Wizard classes
Task-number: QTCREATORBUG-23620
Change-Id: Ia8d27be35911378703126c1e2d06a157ce6185f0
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2020-02-21 11:37:36 +00:00
Eike Ziller
e2fad3afa4 doc: Fix qdoc warnings in aggregation
Change-Id: Ia9a2e6dcdb8dc82ae600b974e396fd8ac3a42678
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2020-02-18 10:02:48 +00:00
Leena Miettinen
8046e3311f Doc: Fix QDoc warnings in Find classes
- Document BaseTextFind and FindSupport
- Mark undocumented classes and namespaces \internal
- Add and fix docs for IFindFilter, SearchResult, and
  SearchResultWindow

Fixes: QTCREATORBUG-23600
Change-Id: Ic9445f7f15562f114f4cbd9fe16988d7249d48db
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2020-02-17 15:45:51 +00:00
Leena Miettinen
d06eee5218 Doc: Fix QDoc warnings in Core plugin dialogs classes
- Fix IOptionsPage class docs
- Mark PromptOverwriteDialog and ReadOnlyFilesDialog

Fixes: QTCREATORBUG-23608
Change-Id: I6a646f0bd68230a7c5f80bd748bda20729f23b74
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2020-02-17 14:56:39 +00:00
Leena Miettinen
e12ba2d683 Doc: Fix broken links in Extending Qt Creator Manual
- Move some images from qtcreator\images to qtcreatordev\images
- Hide directories from the doc build (these will be added
  gradually when we fix the docs for the classes in them)
- Fix broken links
- Add README.md that describes the doc projects in the repo

Fixes: QTCREATORBUG-23544
Change-Id: I4fc29d8fbc8b7a0a0f81fa3261f6412c47b9d84e
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2020-02-10 13:40:43 +00:00
Topi Reinio
4454873b54 Extending Qt Creator Manual: Fix links in the online sidebar
Change-Id: I08ca0c0847c022052428623de3be0416b8682e8d
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2020-02-06 11:54:02 +00:00
Orgad Shaneh
0737291d54 Merge remote-tracking branch 'origin/4.11'
Change-Id: I65ce6aa917219a8f8b91b48c7077f8097248375c
2020-02-06 12:50:22 +02:00
Leena Miettinen
674d342aa9 Doc: Add doc footer and sidebar TOC
These are required for publishing the manual at doc.qt.io.

Because this doc is more a collection of articles than a
traditional guide, list the topics in this guide in the
TOC in alphabetic order.

Change-Id: I2f604ee19f81dcaaccf4601440f178b41b77ec9a
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
2020-02-05 12:11:19 +00:00
Leena Miettinen
18514a5585 Doc: Fix links in the Extending Qt Creator Manual
- Hide links to sections that have not been written yet
- Fix some links to information that was moved
- Use HTTPS in links to Qt Creator Manual topics

Fixes: QTCREATORBUG-23529
Change-Id: Idd162c04fe6992bbecd2acd4a7ec388e49f29b84
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2020-01-29 12:40:39 +00:00
Leena Miettinen
5fc456dd22 Doc: Rearrange files in the doc folder
Source and configuration files for each manual are now located in a
separate subdirectory, with common configuration files in doc/config.

doc
|_config
|_qtcreator
|_qtcreatordev
|_qtdesignstudio

Edit the config files accordingly.

Change-Id: Idc747a7c16e84f3e06add91234dc5fc908e64cc5
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2020-01-27 09:05:07 +00:00