/*
  gammaray-manual.qdoc

  This file is part of GammaRay, the Qt application inspection and manipulation tool.

  SPDX-FileCopyrightText: 2016 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
  Author: Volker Krause <volker.krause@kdab.com>

  SPDX-License-Identifier: GPL-2.0-or-later

  Contact KDAB at <info@kdab.com> for commercial licensing options.
*/

/*!
    \page index.html
    \nextpage gammaray-getting-started.html

    \title GammaRay User Manual

    \section1 What is GammaRay?

    GammaRay is an introspection tool for Qt applications developed by \l{https://www.kdab.com/}{KDAB}.
    Leveraging the QObject introspection mechanism it allows you to observe and manipulate
    your application at runtime. This works both locally on your workstation and remotely
    on an embedded target.

    Augmenting your instruction-level debugger, GammaRay allows you to work on a much
    higher level, with the same concepts as the frameworks you use. This is especially
    useful for the more complex Qt frameworks such as model/view, state machines, or
    scene graphs.

    When trying to analyze bugs in your application, a instruction-level debugger is
    usually your first tool of choice, and rightfully so. Debuggers allow you to follow
    the program flow and allow you to inspect the state of objects or variables.
    When using a debugger with proper Qt integration, such as in QtCreator, it will
    also handle Qt's own data types correctly. However, when dealing with complex
    frameworks this level of detail is often too low-level. Keeping an overview in a
    large scene graph or following the complex interactions between models and views
    can quickly become a cumbersome task.

    GammaRay addresses this by providing domain-specific debugging aids on a much
    higher level. It provides easy ways of navigating through the complex internal
    structures you find in some Qt frameworks, such as the QtQuick scene graphs,
    model/view, QTextDocument, state machines, and more. Unlike the debugger,
    GammaRay understands those internal structures and can present them in a
    meaningful way.

    GammaRay is available for all major platforms and can inspect applications right
    from the start or attach to an already running one. It also supports
    remote debugging, which is especially valuable when working on embedded systems.

    \section1 Table Of Contents
    \list
        \li \l{Getting Started}
        \list
            \li \l{Installation}
            \li \l{Basic Operations}
            \li \l{Graphical Launcher}
            \li \l{GammaRay Client}
            \li \l{Qt Creator Integration}
            \li \l{Command Line Interface}
        \endlist
        \li \l{Tools}
        \list
            \li \l{Qt Quick 2 Inspector}
            \li \l{Widget Inspector}
            \li \l{Graphics Scene Inspector}
            \li \l{Qt3D Inspector}
            \li \l{Styles}
            \li \l{Web Inspector}
            \li \l{State Machine Debugger}
            \li \l{Messages}
            \li \l{Signal Plotter}
            \li \l{Timers}
            \li \l{Events}
            \li \l{Wayland Compositors}
            \li Script Engine Debugger
            \li \l{Object Browser}
            \li \l{Actions}
            \li \l{Models}
            \li \l{Text Documents}
            \li \l{Resources}
            \li \l{Translations}
            \li \l{Meta Object Browser}
            \li \l{Meta Type Browser}
            \li \l{Geo Positioning}
            \li \l{Font Browser}
            \li \l{Locales}
            \li \l{Mime Types}
            \li \l{Network}
            \li \l{Text Codecs}
            \li \l{System Information}
        \endlist
        \li \l{Object Inspection}
        \list
            \li \l{Properties}
            \li \l{Methods}
            \li \l{Connections}
            \li \l{Enums and Flags}
            \li \l{Class Info}
            \li \l{Stack Trace}
            \li \l{Bindings}
            \li \l{QML Context}
            \li \l{QML Type}
            \li \l{Scene Graph Material}
            \li \l{Scene Graph Geometry}
            \li \l{Scene Graph Texture}
            \li \l{Paint Analyzer}
            \li \l{Widget Attributes}
            \li \l{Qt3D Geometry Inspector}
            \li \l{Application Attributes}
            \li \l{HTTP Cookies}
        \endlist
        \li \l{Problem Reporter}
        \li \l{Examples}
        \li \l{Advanced Usage}
        \li \l{Licenses and Attributions}
    \endlist
*/
