From 2cf84b84119e927522c022d7350ff39d8d66d19d Mon Sep 17 00:00:00 2001 From: Leena Miettinen Date: Wed, 27 Jun 2018 17:20:46 +0200 Subject: Doc: Pull information about C++ sidebar views into separate file To make docs more modular. Change-Id: I58095b2b4e9e216808cc4d37b3494480cbf1787c Reviewed-by: Eike Ziller --- doc/src/cpp/creator-sidebar-cpp-views.qdocinc | 78 +++++++++++++++++++++++++++ doc/src/howto/creator-ui.qdoc | 40 +++----------- 2 files changed, 85 insertions(+), 33 deletions(-) create mode 100644 doc/src/cpp/creator-sidebar-cpp-views.qdocinc (limited to 'doc') diff --git a/doc/src/cpp/creator-sidebar-cpp-views.qdocinc b/doc/src/cpp/creator-sidebar-cpp-views.qdocinc new file mode 100644 index 0000000000..5acefba93e --- /dev/null +++ b/doc/src/cpp/creator-sidebar-cpp-views.qdocinc @@ -0,0 +1,78 @@ +/**************************************************************************** +** +** Copyright (C) 2018 The Qt Company Ltd. +** Contact: https://www.qt.io/licensing/ +** +** This file is part of the Qt Creator documentation. +** +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and The Qt Company. For licensing terms +** and conditions see https://www.qt.io/terms-conditions. For further +** information use the contact form at https://www.qt.io/contact-us. +** +** GNU Free Documentation License Usage +** Alternatively, this file may be used under the terms of the GNU Free +** Documentation License version 1.3 as published by the Free Software +** Foundation and appearing in the file included in the packaging of +** this file. Please review the following information to ensure +** the GNU Free Documentation License version 1.3 requirements +** will be met: https://www.gnu.org/licenses/fdl-1.3.html. +** +****************************************************************************/ + +/*! +//! [cpp sidebar views] + +The following views display additional information about C++ code: + + \list + \li \uicontrol {Class View} shows the class hierarchy of the currently + open projects. + \li \uicontrol Tests lists autotests and Qt Quick tests in the project. + For more information, see \l {Running Autotests}. + \li \uicontrol {Type Hierarchy} shows the base classes of a class. + \li \uicontrol {Include Hierarchy} shows which files are included in + the current file and which files include the current file. + \endlist + +//! [cpp sidebar views] + + +//! [class view] + + \section2 Viewing the Class Hierarchy + + The \uicontrol {Class View} shows the class hierarchy of the currently + open projects. To organize the view by subprojects, click + \inlineimage qtcreator-show-subprojects.png + (\uicontrol {Show Subprojects}). + + To visit all parts of a namespace, double-click on the namespace item + multiple times. + +//! [class view] + + +//! [type hierarchy view] + + \section2 Viewing Type Hierarchy + + To view the base classes of a class, right-click the class and select + \uicontrol {Open Type Hierarchy} or press \key {Ctrl+Shift+T}. + +//! [type hierarchy view] + + +//! [include hierarchy view] + + \section2 Viewing Include Hierarchy + + To view which files are included in the current file and which files include + the current file, right-click in the editor and select + \uicontrol {Open Include Hierarchy} or press \key {Ctrl+Shift+I}. + +//! [include hierarchy view] +*/ diff --git a/doc/src/howto/creator-ui.qdoc b/doc/src/howto/creator-ui.qdoc index 5cb7a65a8f..f753e9054a 100644 --- a/doc/src/howto/creator-ui.qdoc +++ b/doc/src/howto/creator-ui.qdoc @@ -136,22 +136,13 @@ \li \uicontrol{File System} shows all files in the currently selected directory. - \li \uicontrol {Class View} shows the class hierarchy of the currently - open projects. - - \li \uicontrol Outline shows the symbol hierarchy of a C++ file and the type - hierarchy of a QML file. - - \li \uicontrol Tests lists autotests and Qt Quick tests in the project. - For more information, see \l {Running Autotests}. - - \li \uicontrol {Type Hierarchy} shows the base classes of a class. - - \li \uicontrol {Include Hierarchy} shows which files are included in the current file - and which files include the current file. + \li \uicontrol Outline shows an overview of defined types and other + symbols, as well as their properties and hierarchy in a source file. \endlist + \include creator-sidebar-cpp-views.qdocinc cpp sidebar views + For more information about the sidebar views that are only available when editing QML files in the Design mode, see \l{Editing QML Files in Design Mode}. @@ -326,16 +317,6 @@ \endlist - \section2 Viewing the Class Hierarchy - - The \uicontrol {Class View} shows the class hierarchy of the currently - open projects. To organize the view by subprojects, click - \inlineimage qtcreator-show-subprojects.png - (\uicontrol {Show Subprojects}). - - To visit all parts of a namespace, double-click on the namespace item - multiple times. - \section2 Viewing QML Types The \uicontrol Outline view shows the type hierarchy in a QML file. @@ -350,16 +331,9 @@ \endlist - \section2 Viewing Type Hierarchy - - To view the base classes of a class, right-click the class and select - \uicontrol {Open Type Hierarchy} or press \key {Ctrl+Shift+T}. - - \section2 Viewing Include Hierarchy - - To view which files are included in the current file and which files include - the current file, right-click in the editor and select \uicontrol {Open Include Hierarchy} - or press \key {Ctrl+Shift+I}. + \include creator-sidebar-cpp-views.qdocinc class view + \include creator-sidebar-cpp-views.qdocinc type hierarchy view + \include creator-sidebar-cpp-views.qdocinc include hierarchy view \section1 Viewing Output -- cgit v1.2.3