diff options
author | Johanna Vanhatapio <[email protected]> | 2025-05-07 13:36:46 +0300 |
---|---|---|
committer | Johanna Vanhatapio <[email protected]> | 2025-05-19 07:08:54 +0000 |
commit | 68fb070e89244f1fa93ba6c04e4d8cb10a35b4ea (patch) | |
tree | 810d2e09c8d0b93f3cafe5d437010624f1a46eef | |
parent | 599f6d98d26ed7753293bdb81916616c1a8e7c86 (diff) |
- Implementing the new doc landing page
template
- Some reorganizing to match the template
- Some work on the transitioning to sentence case
Task-number: QTBUG-136585
Change-Id: I87f03f7d35fd88b80e262d0cbc81e6b9fc18bd1f
Reviewed-by: Nicholas Bennett <[email protected]>
22 files changed, 155 insertions, 51 deletions
diff --git a/doc/config/online/style/qt-sidebar.html b/doc/config/online/style/qt-sidebar.html index 2c6c6e7..12dde8e 100644 --- a/doc/config/online/style/qt-sidebar.html +++ b/doc/config/online/style/qt-sidebar.html @@ -3,21 +3,22 @@ <h2>Overviews</h2> </div> <ul> - <li><a href="http://code.qt.io/index.html#features">Features</a></li> - <li><a href="http://code.qt.io/concepts.html">Concepts</a></li> - <li><a href="http://code.qt.io/qtjenny-configuration.html">Configuration</a></li> + <li><a href="http://code.qt.io/qt-jenny-overview.html#qt-jenny-features">Features</a></li> + <li><a href="http://code.qt.io/qt-jenny-concepts.html">Concepts</a></li> + <li><a href="http://code.qt.io/qt-jenny-configuration.html">Configuration</a></li> </ul> </div> <div class="sectionlist normallist"> <div class="heading"> - <h2>Getting Started</h2> + <h2>Getting started</h2> </div> <ul> - <li><a href="http://code.qt.io/qtjenny-installation.html">Installation</a></li> + <li><a href="http://code.qt.io/qt-jenny-installation.html">Installing Qt Jenny</a></li> + <li><a href="http://code.qt.io/qt-jenny-using.html">Using Qt Jenny</a></li> </ul> </div> <div class="sectionlist normallist"> - <div class="heading"> - <h2><a href="http://code.qt.io/whatsnew.html">What's New</a></h2> - </div> + <ul> + <li><a href="http://code.qt.io/qt-jenny-whatsnew.html">What's new in Qt Jenny</a></li> + </ul> </div> diff --git a/doc/images/icons/api-reference.png b/doc/images/icons/api-reference.png Binary files differnew file mode 100644 index 0000000..543d7d1 --- /dev/null +++ b/doc/images/icons/api-reference.png diff --git a/doc/images/icons/build-32x32.png b/doc/images/icons/build-32x32.png Binary files differnew file mode 100644 index 0000000..d6e045b --- /dev/null +++ b/doc/images/icons/build-32x32.png diff --git a/doc/images/icons/demo-32x32.png b/doc/images/icons/demo-32x32.png Binary files differnew file mode 100644 index 0000000..5c42b6f --- /dev/null +++ b/doc/images/icons/demo-32x32.png diff --git a/doc/images/icons/getting-started.png b/doc/images/icons/getting-started.png Binary files differnew file mode 100644 index 0000000..36b37d4 --- /dev/null +++ b/doc/images/icons/getting-started.png diff --git a/doc/images/icons/installation.png b/doc/images/icons/installation.png Binary files differnew file mode 100644 index 0000000..6dc6a8e --- /dev/null +++ b/doc/images/icons/installation.png diff --git a/doc/images/icons/settings-32x32.png b/doc/images/icons/settings-32x32.png Binary files differnew file mode 100644 index 0000000..5c7202a --- /dev/null +++ b/doc/images/icons/settings-32x32.png diff --git a/doc/src/images/icons/api-reference.png b/doc/src/images/icons/api-reference.png Binary files differnew file mode 100644 index 0000000..543d7d1 --- /dev/null +++ b/doc/src/images/icons/api-reference.png diff --git a/doc/src/images/icons/build-32x32.png b/doc/src/images/icons/build-32x32.png Binary files differnew file mode 100644 index 0000000..d6e045b --- /dev/null +++ b/doc/src/images/icons/build-32x32.png diff --git a/doc/src/images/icons/demo-32x32.png b/doc/src/images/icons/demo-32x32.png Binary files differnew file mode 100644 index 0000000..5c42b6f --- /dev/null +++ b/doc/src/images/icons/demo-32x32.png diff --git a/doc/src/images/icons/getting-started.png b/doc/src/images/icons/getting-started.png Binary files differnew file mode 100644 index 0000000..36b37d4 --- /dev/null +++ b/doc/src/images/icons/getting-started.png diff --git a/doc/src/images/icons/installation.png b/doc/src/images/icons/installation.png Binary files differnew file mode 100644 index 0000000..6dc6a8e --- /dev/null +++ b/doc/src/images/icons/installation.png diff --git a/doc/src/images/icons/settings-32x32.png b/doc/src/images/icons/settings-32x32.png Binary files differnew file mode 100644 index 0000000..5c7202a --- /dev/null +++ b/doc/src/images/icons/settings-32x32.png diff --git a/doc/src/concepts.qdoc b/doc/src/qt-jenny-concepts.qdoc index 0885264..267c774 100644 --- a/doc/src/concepts.qdoc +++ b/doc/src/qt-jenny-concepts.qdoc @@ -1,8 +1,8 @@ // Copyright (C) 2024 The Qt Company Ltd. // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only /*! -\page concepts.html -\title Concepts and Architecture +\page qt-jenny-concepts.html +\title Qt Jenny concepts and architecture Qt Jenny depends on the following set of key concepts: diff --git a/doc/src/configuration.qdoc b/doc/src/qt-jenny-configuration.qdoc index 122ac32..0656d32 100644 --- a/doc/src/configuration.qdoc +++ b/doc/src/qt-jenny-configuration.qdoc @@ -1,16 +1,14 @@ -// Copyright (C) 2024 The Qt Company Ltd. +// Copyright (C) 2025 The Qt Company Ltd. // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only /*! -\page qtjenny-configuration.html -\title Configuration - -\section1 Runtime Configuration +\page qt-jenny-configuration.html +\title Qt Jenny runtime configuration The following environment variables are supported for runtime configurations: \table \header - \li Environment Variable + \li Environment variable \li Description \row \li diff --git a/doc/src/external-resources.qdoc b/doc/src/qt-jenny-external-resources.qdoc index 75236d8..75236d8 100644 --- a/doc/src/external-resources.qdoc +++ b/doc/src/qt-jenny-external-resources.qdoc diff --git a/doc/src/qt-jenny-getting-started.qdoc b/doc/src/qt-jenny-getting-started.qdoc new file mode 100644 index 0000000..c638de7 --- /dev/null +++ b/doc/src/qt-jenny-getting-started.qdoc @@ -0,0 +1,13 @@ +// Copyright (C) 2025 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only +/*! +\page qtjenny-getting-started.html +\title Getting started with Qt Jenny + +\list + \li \l {Installing Qt Jenny} + \li \l {Using Qt Jenny} + //! TODO: add a topic on how to use Qt Jenny. +\endlist + +*/ diff --git a/doc/src/installation.qdoc b/doc/src/qt-jenny-installation.qdoc index 4c1cdf6..98c00c3 100644 --- a/doc/src/installation.qdoc +++ b/doc/src/qt-jenny-installation.qdoc @@ -1,14 +1,14 @@ // Copyright (C) 2024 The Qt Company Ltd. // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only /*! -\page qtjenny-installation.html -\title Installation +\page qt-jenny-installation.html +\title Installing Qt Jenny To install Qt Jenny: \section1 Getting Qt Jenny -\section1 Installing It +\section1 Installing it diff --git a/doc/src/qt-jenny-topics.qdoc b/doc/src/qt-jenny-topics.qdoc new file mode 100644 index 0000000..33416fc --- /dev/null +++ b/doc/src/qt-jenny-topics.qdoc @@ -0,0 +1,49 @@ +// Copyright (C) 2025 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only + +/*! + \page qt-jenny-overview.html + \title Qt Jenny: Java Code Generator + \brief About Qt Jenny. + \target Qt Jenny + + Qt Jenny translates Java APIs to C++ wrappers. See \l{Get Started with Qt Jenny} + to start creating your C++ wrappers. + + \section1 Qt Jenny features + + \list + \li + //! TODO: add a list of features + \endlist + + \section1 How Qt Jenny works + + Qt Jenny translates Java APIs to C++ wrappers by... + //! TODO: explain this + + \image qtjenny-overview.png "Qt Jenny Architecture" + + \note There is no compatibility guarantee for the autogenerated code. This + means that even application code that uses the autogenerated code is only + guaranteed to work with the Qt Jenny version it was developed + against. We try to keep the API source compatible for as long as possible. +*/ + +/*! + \page qt-jenny-references.html + \title References for Qt Jenny + + //! TODO: Are there any references around code generation the reader could benefit from + +*/ + +/*! + \page qt-jenny-licenses.html + \title Licenses and attributions for Qt Jenny + + Qt Jenny potentially contains third-party modules under the following + permissive licenses: + + \generatelist{groupsbymodule attributions-qtjenny} +*/ diff --git a/doc/src/qt-jenny-using.qdoc b/doc/src/qt-jenny-using.qdoc new file mode 100644 index 0000000..43e9115 --- /dev/null +++ b/doc/src/qt-jenny-using.qdoc @@ -0,0 +1,9 @@ +// Copyright (C) 2025 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only +/*! +\page qt-jenny-using.html +\title Using Qt Jenny + +This topic describes how to use Qt Jenny. + +*/ diff --git a/doc/src/whatsnew.qdoc b/doc/src/qt-jenny-whatsnew.qdoc index 6ff7348..b6558d4 100644 --- a/doc/src/whatsnew.qdoc +++ b/doc/src/qt-jenny-whatsnew.qdoc @@ -1,10 +1,10 @@ // Copyright (C) 2024 The Qt Company Ltd. // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only /*! -\page whatsnew.html -\title What's New in Qt Jenny +\page qt-jenny-whatsnew.html +\title What's new in Qt Jenny -The following page describes new features by version +The following page describes new features by version. \section1 Qt Jenny 1.0 diff --git a/doc/src/qt-jenny.qdoc b/doc/src/qt-jenny.qdoc index d2fab0d..eb534a2 100644 --- a/doc/src/qt-jenny.qdoc +++ b/doc/src/qt-jenny.qdoc @@ -1,46 +1,80 @@ -// Copyright (C) 2024 The Qt Company Ltd. +// Copyright (C) 2025 The Qt Company Ltd. // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only /*! \page index.html - \title Qt Jenny: Java Code Generator - \brief Overview of Qt Jenny - \target Qt Jenny - Qt Jenny translates Java APIs to C++ wrappers. - - \section1 Features - - Qt Jenny's features: - \list - \li - //! TODO: add a list of features - \endlist + \title Qt Jenny documentation - See \l{Get Started with Qt Jenny} to start creating your C++ wrappers. + \raw HTML + <style> + .main-navigation table { table-layout: fixed; } + .main-navigation table tr:first-child { text-align: center; background: none; } + </style> + \endraw - \section1 How Qt Jenny works + \div {class="main-navigation"} + \table borderless 100% + \row + \li \inlineimage icons/installation.png + \li \inlineimage icons/getting-started.png + \li \inlineimage icons/api-reference.png + \row + \li \b {INSTALLATION} - Qt Jenny translates Java APIs to C++ wrappers by... - //! TODO: explain this + Learn how to install Qt Jenny. - \image qtjenny-overview.png "Qt Jenny Architecture" + \l {Installing Qt Jenny} + \li \b {GETTING STARTED} - \note There is no compatibility guarantee for the autogenerated code. This - means that even application code that uses the autogenerated code is only - guaranteed to work with the Qt Jenny version it was developed - against. We try to keep the API source compatible for as long as possible. + See here to get started with Qt Jenny. + \l{Getting Started with Qt Jenny} + \li \b {REFERENCES} - \section1 Reference + See here for references for using Qt Jenny. - //! TODO: Are there any references around code generation the reader could benefit from + \l{References for Qt Jenny} + \endtable + \enddiv - \section1 Licenses and Attributions + \section1 About - Qt Jenny potentially contains third-party modules under the following - permissive licenses: - - \generatelist{groupsbymodule attributions-qtjenny} + Qt Jenny translates Java APIs to C++ wrappers. + \b {ALL TOPICS} + + \raw HTML + <style> + .link-list table { table-layout: fixed; } + .link-list table, .link-list table tr:first-child { background: none; border: none; } + </style> + \endraw + + \div {class="link-list"} + \table 100% + \row + \li \inlineimage icons/demo-32x32.png + \li \inlineimage icons/settings-32x32.png + \li \inlineimage icons/build-32x32.png + \row + \li Overview + \list + \li \l {Qt Jenny: Java Code Generator} + \li \l {Qt Jenny concepts and architecture} + \li \l {Qt Jenny runtime configuration} + \endlist + \li Getting started + \list + \li \l {Installing Qt Jenny} + \li \l {Using Qt Jenny} + \endlist + \li More topics + \list + \li \l {References for Qt Jenny} + \li \l {Licenses and attributions for Qt Jenny} + \li \l {What's new in Qt Jenny} + \endlist + \endtable + \enddiv */ |