Commit Graph

17 Commits

Author SHA1 Message Date
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