summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorMichael McClurg <michael.mcclurg@outlook.com>2022-04-08 11:39:44 -0600
committerAllen Winter <allen.winter@kdab.com>2022-04-09 08:27:19 -0400
commit5764f71b2e064ff622e67449e5bec770c0ae28b6 (patch)
tree756e4558190822f4879268ec18623065f6fe70de /doc
parentbd3e04552a2beb105510eefb631c82de286237fb (diff)
downloadlibical-git-5764f71b2e064ff622e67449e5bec770c0ae28b6.tar.gz
Add UsingLibical.md to Doxygen
Diffstat (limited to 'doc')
-rw-r--r--doc/CMakeLists.txt2
-rw-r--r--doc/Doxyfile.cmake3
-rw-r--r--doc/Mainpage.dox3
-rw-r--r--doc/UsingLibical.md2
4 files changed, 7 insertions, 3 deletions
diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt
index 5a33a4d3..e126e1ed 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)
+ file(GLOB _dox_deps *.dox *.html *.md)
file(GLOB _all_hdrs
${CMAKE_SOURCE_DIR}/src/libical/*.h
${CMAKE_SOURCE_DIR}/src/libical/*.c
diff --git a/doc/Doxyfile.cmake b/doc/Doxyfile.cmake
index 0573c0e7..daa9bae4 100644
--- a/doc/Doxyfile.cmake
+++ b/doc/Doxyfile.cmake
@@ -86,6 +86,7 @@ FILE_PATTERNS = *.cpp \
*.hh \
*.hxx \
*.hpp \
+ *.md \
*.dox
RECURSIVE = YES
EXCLUDE = @CMAKE_SOURCE_DIR@/src/java \
@@ -106,7 +107,7 @@ EXCLUDE_PATTERNS = */.svn/* \
EXAMPLE_PATH =
EXAMPLE_PATTERNS = *
EXAMPLE_RECURSIVE = NO
-IMAGE_PATH = @CMAKE_SOURCE_DIR@/docs
+IMAGE_PATH = @CMAKE_SOURCE_DIR@/doc
INPUT_FILTER =
FILTER_PATTERNS =
FILTER_SOURCE_FILES = NO
diff --git a/doc/Mainpage.dox b/doc/Mainpage.dox
index 45fa36e0..28b43b76 100644
--- a/doc/Mainpage.dox
+++ b/doc/Mainpage.dox
@@ -13,6 +13,9 @@ 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
diff --git a/doc/UsingLibical.md b/doc/UsingLibical.md
index e8ab163c..4e13d02b 100644
--- a/doc/UsingLibical.md
+++ b/doc/UsingLibical.md
@@ -1,4 +1,4 @@
-# Using Libical
+# Using Libical {#UsingLibical}
> Author: Eric Busboom <eric@civicknowledge.com>
>