From 27dcf14de41f59080eca34395c56dda403d1a2d1 Mon Sep 17 00:00:00 2001
From: "Friedrich W. H. Kossebau" <kossebau@kde.org>
Date: Fri, 29 May 2020 16:27:19 +0200
Subject: [PATCH] Add support for API docs generation with kapidox

---
 CMakeLists.txt                     |   6 ++---
 Doxyfile.in                        |   2 +-
 docs/Doxyfile.local                |   3 +++
 {images => docs/pics}/qca-arch.eps |   0
 {images => docs/pics}/qca-arch.png | Bin
 {images => docs/pics}/qca-arch.svg |   0
 metainfo.yaml                      |  40 +++++++++++++++++++++++++++++
 7 files changed, 47 insertions(+), 4 deletions(-)
 create mode 100644 docs/Doxyfile.local
 rename {images => docs/pics}/qca-arch.eps (100%)
 rename {images => docs/pics}/qca-arch.png (100%)
 rename {images => docs/pics}/qca-arch.svg (100%)
 create mode 100644 metainfo.yaml

diff --git a/CMakeLists.txt b/CMakeLists.txt
index 42cd3049..16f8dbf9 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -380,9 +380,9 @@ if(DOXYGEN_FOUND)
   configure_file(${CMAKE_SOURCE_DIR}/Doxyfile.in ${CMAKE_BINARY_DIR}/Doxyfile @ONLY)
   add_custom_target(doc
     ${DOXYGEN_EXECUTABLE} ${CMAKE_BINARY_DIR}/Doxyfile
-    COMMAND ${CMAKE_COMMAND} -E make_directory ${CMAKE_BINARY_DIR}/images
-    COMMAND ${CMAKE_COMMAND} -E copy_if_different ${CMAKE_SOURCE_DIR}/images/qca-arch.eps ${CMAKE_BINARY_DIR}/images/qca-arch.eps
-    COMMAND ${CMAKE_COMMAND} -E copy_if_different ${CMAKE_SOURCE_DIR}/images/qca-arch.png ${CMAKE_BINARY_DIR}/images/qca-arch.png
+    COMMAND ${CMAKE_COMMAND} -E make_directory ${CMAKE_BINARY_DIR}/docs/pics
+    COMMAND ${CMAKE_COMMAND} -E copy_if_different ${CMAKE_SOURCE_DIR}/docs/pics/qca-arch.eps ${CMAKE_BINARY_DIR}/docs/pics/qca-arch.eps
+    COMMAND ${CMAKE_COMMAND} -E copy_if_different ${CMAKE_SOURCE_DIR}/docs/pics/qca-arch.png ${CMAKE_BINARY_DIR}/docs/pics/qca-arch.png
     WORKING_DIRECTORY ${CMAKE_BINARY_DIR}
     COMMENT "Generating API documentation with Doxygen" VERBATIM)
 endif()
diff --git a/Doxyfile.in b/Doxyfile.in
index 844c234b..6100ed6b 100644
--- a/Doxyfile.in
+++ b/Doxyfile.in
@@ -567,7 +567,7 @@ EXAMPLE_RECURSIVE      = NO
 # directories that contain image that are included in the documentation (see 
 # the \image command).
 
-IMAGE_PATH             = @CMAKE_SOURCE_DIR@/images
+IMAGE_PATH             = @CMAKE_SOURCE_DIR@/docs/pics
 
 # The INPUT_FILTER tag can be used to specify a program that doxygen should 
 # invoke to filter for each input file. Doxygen will invoke the filter program 
diff --git a/docs/Doxyfile.local b/docs/Doxyfile.local
new file mode 100644
index 00000000..59a2af14
--- /dev/null
+++ b/docs/Doxyfile.local
@@ -0,0 +1,3 @@
+### KApiDox Project-specific Overrides File
+
+FILE_PATTERNS += *.doco
diff --git a/images/qca-arch.eps b/docs/pics/qca-arch.eps
similarity index 100%
rename from images/qca-arch.eps
rename to docs/pics/qca-arch.eps
diff --git a/images/qca-arch.png b/docs/pics/qca-arch.png
similarity index 100%
rename from images/qca-arch.png
rename to docs/pics/qca-arch.png
diff --git a/images/qca-arch.svg b/docs/pics/qca-arch.svg
similarity index 100%
rename from images/qca-arch.svg
rename to docs/pics/qca-arch.svg
diff --git a/metainfo.yaml b/metainfo.yaml
new file mode 100644
index 00000000..04b0eb05
--- /dev/null
+++ b/metainfo.yaml
@@ -0,0 +1,40 @@
+maintainer: sitter
+fancyname: QCA
+description: QCA (Qt Cryptographic Architecture) provides a straightforward and cross-platform crypto API
+platforms:
+    - name: Linux
+    - name: FreeBSD
+    - name: Windows
+#    - name: MacOSX
+#    - name: Android
+release: true
+public_lib: true
+public_source_dirs:
+    - include/QtCrypto
+    - examples
+public_doc_dir:
+    - docs
+public_example_dirs:
+    - examples/aes-cmac
+    - examples/base64test
+    - examples/certtest
+    - examples/ciphertest
+    - examples/cms
+    - examples/cmssigner
+    - examples/eventhandlerdemo
+    - examples/hashtest
+    - examples/hextest
+    - examples/keyloader
+    - examples/mactest
+    - examples/md5crypt
+    - examples/providertest
+    - examples/publickeyexample
+    - examples/randomtest
+    - examples/rsatest
+    - examples/saslclient
+    - examples/saslserver
+    - examples/ssltest
+    - examples/sslservtest
+    - examples/tlssocket
+irc: kde-devel
+mailinglist: kde-core-devel