From 68fb070e89244f1fa93ba6c04e4d8cb10a35b4ea Mon Sep 17 00:00:00 2001 From: Johanna Vanhatapio Date: Wed, 7 May 2025 13:36:46 +0300 Subject: Doc: Update the Qt Jenny landing page - 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 --- doc/src/concepts.qdoc | 17 ------ doc/src/configuration.qdoc | 36 ------------ doc/src/external-resources.qdoc | 7 --- doc/src/images/icons/api-reference.png | Bin 0 -> 5796 bytes doc/src/images/icons/build-32x32.png | Bin 0 -> 1718 bytes doc/src/images/icons/demo-32x32.png | Bin 0 -> 978 bytes doc/src/images/icons/getting-started.png | Bin 0 -> 4708 bytes doc/src/images/icons/installation.png | Bin 0 -> 4409 bytes doc/src/images/icons/settings-32x32.png | Bin 0 -> 2168 bytes doc/src/installation.qdoc | 15 ----- doc/src/qt-jenny-concepts.qdoc | 17 ++++++ doc/src/qt-jenny-configuration.qdoc | 34 ++++++++++++ doc/src/qt-jenny-external-resources.qdoc | 7 +++ doc/src/qt-jenny-getting-started.qdoc | 13 +++++ doc/src/qt-jenny-installation.qdoc | 15 +++++ doc/src/qt-jenny-topics.qdoc | 49 ++++++++++++++++ doc/src/qt-jenny-using.qdoc | 9 +++ doc/src/qt-jenny-whatsnew.qdoc | 16 ++++++ doc/src/qt-jenny.qdoc | 92 +++++++++++++++++++++---------- doc/src/whatsnew.qdoc | 16 ------ 20 files changed, 223 insertions(+), 120 deletions(-) delete mode 100644 doc/src/concepts.qdoc delete mode 100644 doc/src/configuration.qdoc delete mode 100644 doc/src/external-resources.qdoc create mode 100644 doc/src/images/icons/api-reference.png create mode 100644 doc/src/images/icons/build-32x32.png create mode 100644 doc/src/images/icons/demo-32x32.png create mode 100644 doc/src/images/icons/getting-started.png create mode 100644 doc/src/images/icons/installation.png create mode 100644 doc/src/images/icons/settings-32x32.png delete mode 100644 doc/src/installation.qdoc create mode 100644 doc/src/qt-jenny-concepts.qdoc create mode 100644 doc/src/qt-jenny-configuration.qdoc create mode 100644 doc/src/qt-jenny-external-resources.qdoc create mode 100644 doc/src/qt-jenny-getting-started.qdoc create mode 100644 doc/src/qt-jenny-installation.qdoc create mode 100644 doc/src/qt-jenny-topics.qdoc create mode 100644 doc/src/qt-jenny-using.qdoc create mode 100644 doc/src/qt-jenny-whatsnew.qdoc delete mode 100644 doc/src/whatsnew.qdoc (limited to 'doc/src') diff --git a/doc/src/concepts.qdoc b/doc/src/concepts.qdoc deleted file mode 100644 index 0885264..0000000 --- a/doc/src/concepts.qdoc +++ /dev/null @@ -1,17 +0,0 @@ -// 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 - -Qt Jenny depends on the following set of key concepts: - -\list - \li The \l{Gradle} build tool. - \li - \li - \li - \li - \li -\endlist -*/ diff --git a/doc/src/configuration.qdoc b/doc/src/configuration.qdoc deleted file mode 100644 index 122ac32..0000000 --- a/doc/src/configuration.qdoc +++ /dev/null @@ -1,36 +0,0 @@ -// Copyright (C) 2024 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 - -The following environment variables are supported for runtime configurations: - -\table - \header - \li Environment Variable - \li Description - \row - \li - \li - \row - \li - \li - \row - \li - \li - \row - \li - \li - \row - \li - \li -\endtable - -\section2 Logging -\target logging_configuration - - -*/ diff --git a/doc/src/external-resources.qdoc b/doc/src/external-resources.qdoc deleted file mode 100644 index 75236d8..0000000 --- a/doc/src/external-resources.qdoc +++ /dev/null @@ -1,7 +0,0 @@ -// Copyright (C) 2021 The Qt Company Ltd. -// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only - -/*! - \externalpage https://gradle.org/ - \title Gradle -*/ diff --git a/doc/src/images/icons/api-reference.png b/doc/src/images/icons/api-reference.png new file mode 100644 index 0000000..543d7d1 Binary files /dev/null and b/doc/src/images/icons/api-reference.png differ diff --git a/doc/src/images/icons/build-32x32.png b/doc/src/images/icons/build-32x32.png new file mode 100644 index 0000000..d6e045b Binary files /dev/null and b/doc/src/images/icons/build-32x32.png differ diff --git a/doc/src/images/icons/demo-32x32.png b/doc/src/images/icons/demo-32x32.png new file mode 100644 index 0000000..5c42b6f Binary files /dev/null and b/doc/src/images/icons/demo-32x32.png differ diff --git a/doc/src/images/icons/getting-started.png b/doc/src/images/icons/getting-started.png new file mode 100644 index 0000000..36b37d4 Binary files /dev/null and b/doc/src/images/icons/getting-started.png differ diff --git a/doc/src/images/icons/installation.png b/doc/src/images/icons/installation.png new file mode 100644 index 0000000..6dc6a8e Binary files /dev/null and b/doc/src/images/icons/installation.png differ diff --git a/doc/src/images/icons/settings-32x32.png b/doc/src/images/icons/settings-32x32.png new file mode 100644 index 0000000..5c7202a Binary files /dev/null and b/doc/src/images/icons/settings-32x32.png differ diff --git a/doc/src/installation.qdoc b/doc/src/installation.qdoc deleted file mode 100644 index 4c1cdf6..0000000 --- a/doc/src/installation.qdoc +++ /dev/null @@ -1,15 +0,0 @@ -// 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 - -To install Qt Jenny: - -\section1 Getting Qt Jenny - -\section1 Installing It - - - -*/ diff --git a/doc/src/qt-jenny-concepts.qdoc b/doc/src/qt-jenny-concepts.qdoc new file mode 100644 index 0000000..267c774 --- /dev/null +++ b/doc/src/qt-jenny-concepts.qdoc @@ -0,0 +1,17 @@ +// Copyright (C) 2024 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only +/*! +\page qt-jenny-concepts.html +\title Qt Jenny concepts and architecture + +Qt Jenny depends on the following set of key concepts: + +\list + \li The \l{Gradle} build tool. + \li + \li + \li + \li + \li +\endlist +*/ diff --git a/doc/src/qt-jenny-configuration.qdoc b/doc/src/qt-jenny-configuration.qdoc new file mode 100644 index 0000000..0656d32 --- /dev/null +++ b/doc/src/qt-jenny-configuration.qdoc @@ -0,0 +1,34 @@ +// Copyright (C) 2025 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only +/*! +\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 Description + \row + \li + \li + \row + \li + \li + \row + \li + \li + \row + \li + \li + \row + \li + \li +\endtable + +\section2 Logging +\target logging_configuration + + +*/ diff --git a/doc/src/qt-jenny-external-resources.qdoc b/doc/src/qt-jenny-external-resources.qdoc new file mode 100644 index 0000000..75236d8 --- /dev/null +++ b/doc/src/qt-jenny-external-resources.qdoc @@ -0,0 +1,7 @@ +// Copyright (C) 2021 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only + +/*! + \externalpage https://gradle.org/ + \title Gradle +*/ 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/qt-jenny-installation.qdoc b/doc/src/qt-jenny-installation.qdoc new file mode 100644 index 0000000..98c00c3 --- /dev/null +++ b/doc/src/qt-jenny-installation.qdoc @@ -0,0 +1,15 @@ +// Copyright (C) 2024 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only +/*! +\page qt-jenny-installation.html +\title Installing Qt Jenny + +To install Qt Jenny: + +\section1 Getting Qt Jenny + +\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/qt-jenny-whatsnew.qdoc b/doc/src/qt-jenny-whatsnew.qdoc new file mode 100644 index 0000000..b6558d4 --- /dev/null +++ b/doc/src/qt-jenny-whatsnew.qdoc @@ -0,0 +1,16 @@ +// Copyright (C) 2024 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only +/*! +\page qt-jenny-whatsnew.html +\title What's new in Qt Jenny + +The following page describes new features by version. + +\section1 Qt Jenny 1.0 + +\list + \li + //! TODO: add list of features +\endlist + +*/ 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 + + \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 + + \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 */ diff --git a/doc/src/whatsnew.qdoc b/doc/src/whatsnew.qdoc deleted file mode 100644 index 6ff7348..0000000 --- a/doc/src/whatsnew.qdoc +++ /dev/null @@ -1,16 +0,0 @@ -// 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 - -The following page describes new features by version - -\section1 Qt Jenny 1.0 - -\list - \li - //! TODO: add list of features -\endlist - -*/ -- cgit v1.2.3