forked from qt-creator/qt-creator
Doc: Pull information about C++ sidebar views into separate file
To make docs more modular. Change-Id: I58095b2b4e9e216808cc4d37b3494480cbf1787c Reviewed-by: Eike Ziller <eike.ziller@qt.io>
This commit is contained in:
78
doc/src/cpp/creator-sidebar-cpp-views.qdocinc
Normal file
78
doc/src/cpp/creator-sidebar-cpp-views.qdocinc
Normal file
@@ -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]
|
||||
*/
|
||||
Reference in New Issue
Block a user