diff options
author | Michael McClurg <michael.mcclurg@outlook.com> | 2022-04-23 17:59:06 -0600 |
---|---|---|
committer | Allen Winter <allen.winter@kdab.com> | 2022-04-24 07:41:06 -0400 |
commit | 7f704bd9dd9e76f055456fec39b5d037bfdce697 (patch) | |
tree | 4b05a80254c3ddebee341452d1d3442c4029d5a1 | |
parent | 7ac64a1047cdc9786e5f9a163159a59c60e831db (diff) | |
download | libical-git-7f704bd9dd9e76f055456fec39b5d037bfdce697.tar.gz |
WIP: use README.md copy as doxygen mainpage
-rw-r--r-- | README.md | 25 | ||||
-rw-r--r-- | doc/CMakeLists.txt | 2 | ||||
-rw-r--r-- | doc/Mainpage.dox | 40 |
3 files changed, 15 insertions, 52 deletions
@@ -1,8 +1,8 @@ -# Libical +# Libical — an implementation of iCalendar protocols and data formats {#mainpage} [![Appveyor status](https://ci.appveyor.com/api/projects/status/github/libical/libical?branch=master?svg=true)](https://ci.appveyor.com/api/projects/status/github/libical/libical) [![Packaging status](https://repology.org/badge/tiny-repos/libical.svg)](https://repology.org/metapackage/libical) -## Introduction +## About Libical — an implementation of iCalendar protocols and data formats @@ -31,8 +31,8 @@ plus the iCalendar iMIP protocol in [RFC6047][]. [RFC9074]: https://tools.ietf.org/html/rfc9074 The libical-glib API is currently unstable and can change with any release. -Until it is considered stable, there should be defined LIBICAL_GLIB_UNSTABLE_API=1 -before including <libical-glib/libical-glib.h>, to indicate that the library user +Until it is considered stable, there should be defined `LIBICAL_GLIB_UNSTABLE_API=1` +before including `<libical-glib/libical-glib.h>`, to indicate that the library user is aware of it and is prepared to change the calls anytime. ## License @@ -56,12 +56,15 @@ See the top-level [Install.txt](Install.txt) file. ## Documentation -There is rudimentary, unfinished documentation in the `doc/` directory, -see [UsingLibical.md](doc/UsingLibical.md) +Documentation is hosted at <https://libical.github.io/libical/apidocs/>. + +For a conceptual overview of the library, see [UsingLibical.md](@ref UsingLibical). +There is other rudimentary, unfinished documentation in the `doc/` directory of +the source distribution, and annotated examples in `examples/` and the test code in `src/test/`. Additionally, progress is underway to add API documentation, -which is available [here](https://libical.github.io/libical/apidocs/index.html) +which is available at the apidocs site. ## Acknowledgments @@ -86,10 +89,10 @@ In no particular order: * [GNOME Todo](https://wiki.gnome.org/Apps/Todo) * and more GNOME apps... - * KDE's [Kontact Suite](https://kontact.kde.org) - * [Akonadi framework](https://kontact.kde.org/components/akonadi.html) - * [KOrganizer calendar and scheduling component](https://kontact.kde.org/components/korganizer.html) - * and more KDE apps... +* KDE's [Kontact Suite](https://kontact.kde.org) + * [Akonadi framework](https://kontact.kde.org/components/akonadi.html) + * [KOrganizer calendar and scheduling component](https://kontact.kde.org/components/korganizer.html) + * and more KDE apps... ## Get Involved diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt index e126e1ed..699913f0 100644 --- a/doc/CMakeLists.txt +++ b/doc/CMakeLists.txt @@ -18,7 +18,7 @@ set_package_properties(Doxygen PROPERTIES PURPOSE "Needed to build the API documentation." ) if(DOXYGEN_FOUND) - file(GLOB _dox_deps *.dox *.html *.md) + file(GLOB _dox_deps *.dox *.html *.md ${CMAKE_SOURCE_DIR}/README.md) file(GLOB _all_hdrs ${CMAKE_SOURCE_DIR}/src/libical/*.h ${CMAKE_SOURCE_DIR}/src/libical/*.c diff --git a/doc/Mainpage.dox b/doc/Mainpage.dox deleted file mode 100644 index 28b43b76..00000000 --- a/doc/Mainpage.dox +++ /dev/null @@ -1,40 +0,0 @@ -/*! -@mainpage Libical - an implementation of iCalendar protocols and data formats - -@section about About - -Libical is an Open Source implementation of the iCalendar protocols -and protocol data units. The iCalendar specification describes how -calendar clients can communicate with calendar servers so users can -store their calendar data and arrange meetings with other users. - -Libical implements RFC5545, RFC5546, RFC7529; -the CalDav scheduling extensions in RFC6638; -iCalendar extensions in RFC7986, RFC9073, RFC9074; -plus the iCalendar iMIP protocol in RFC6047. - -For a conceptual overview of the library, see -[Using Libical](@ref UsingLibical). - -@section license License - -The code and datafiles in this distribution are licensed under the -Mozilla Public License (MPL) v2.0. See https://www.mozilla.org/MPL -for a copy of the license. - -Alternately, you may use libical under the terms of the GNU Library -General Public License (LGPL) v2.1. See https://www.gnu.org/licenses/lgpl-2.1.txt -for a copy of the license. - -This dual license ensures that the library can be incorporated into -both proprietary code and GPL'd programs, and will benefit from improvements -made by programmers in both realms. I will only accept changes into -my version of the library if they are similarly dual-licensed. - -@section acknowledgements Acknowledgments - -Portions of this distribution are (C) Copyright 1996 Apple Computer, -Inc., AT&T Corp., International Business Machines Corporation and -Siemens Rolm Communications Inc. See src/libicalvcal/README.TXT for details. - -*/ |