From 4cf5ef004f96152a52fa8e68998568967c930599 Mon Sep 17 00:00:00 2001 From: Mat Sutcliffe Date: Wed, 22 Jul 2020 00:14:45 +0100 Subject: [PATCH] [doxygen] Update mainpage --- README.md | 2 +- docs/src/groups.dox | 11 ----------- docs/src/license.dox | 8 -------- docs/src/mainpage.dox | 24 +++++------------------- docs/src/wiki/developersguide.dox | 8 -------- 5 files changed, 6 insertions(+), 47 deletions(-) delete mode 100644 docs/src/groups.dox delete mode 100644 docs/src/license.dox delete mode 100644 docs/src/wiki/developersguide.dox diff --git a/README.md b/README.md index f3b4fb934..bb0bbf1c4 100644 --- a/README.md +++ b/README.md @@ -41,4 +41,4 @@ _swift_ is written in modern C++14 using the Qt framework. Pull requests should be made against the current active development branch, which is `develop/0.9.5`. -[:blue_book: Developer documentation](https://docs.swift-project.org/dev/) +[:blue_book: Developer guide](https://docs.swift-project.org/doku.php?id=developer_documentation) diff --git a/docs/src/groups.dox b/docs/src/groups.dox deleted file mode 100644 index 4db3e7fd6..000000000 --- a/docs/src/groups.dox +++ /dev/null @@ -1,11 +0,0 @@ -// define all of the file groups used to structure the documentation. - -/*! - \defgroup samples Sample programs demonstrating the usage of swift API -*/ - -//! \cond PRIVATE_TESTS -/*! - \defgroup tests Test applications -*/ -//! \endcond diff --git a/docs/src/license.dox b/docs/src/license.dox deleted file mode 100644 index ff9beae08..000000000 --- a/docs/src/license.dox +++ /dev/null @@ -1,8 +0,0 @@ -/*! - -\page license swift license - -All legal information about the swift project can be found here:
-swift license - -*/ diff --git a/docs/src/mainpage.dox b/docs/src/mainpage.dox index cf2581383..70fcb551c 100644 --- a/docs/src/mainpage.dox +++ b/docs/src/mainpage.dox @@ -8,25 +8,11 @@ \a swift is a cross-platform, open source client application for virtual air traffic simulation written in C++/Qt. The application allows users of flight simulation software to connect to online networks as pilots and interact with virtual air traffic controllers. -\section starthere Start here +\section links Links -- \ref developersguide "Developers’ Guide"
-Guide and design documentation - -- \ref samples "Samples"
-Simple sample programs demonstrating swift library usage - -\if PRIVATE_TESTS -- \ref tests "Tests"
-Unit and integration tests -\endif - -- \ref license "swift license"
-\a swift is licenced under the GPLv3 with exceptions. - -\section resources Resources - -- swift BLOG website -- swift developer website +- swift website +- user guide +- developer guide +- github repository */ diff --git a/docs/src/wiki/developersguide.dox b/docs/src/wiki/developersguide.dox deleted file mode 100644 index 890ab3aa7..000000000 --- a/docs/src/wiki/developersguide.dox +++ /dev/null @@ -1,8 +0,0 @@ -/*! - -\page developersguide Developers Guide -\ingroup developersguide - -see developer documentation here - -*/