summaryrefslogtreecommitdiffstats
path: root/libdlmclient/docs
diff options
context:
space:
mode:
authorDamian Hobson-Garcia <dhobsong@igel.co.jp>2020-11-24 17:16:39 +0900
committerDamian Hobson-Garcia <dhobsong@igel.co.jp>2021-02-19 10:48:23 +0000
commitf991de200799118355fd75237a740321bda7aaa7 (patch)
tree589f536d835d81f1166410e67aedb578d6e70395 /libdlmclient/docs
parent464ec461237b36e03c4cdb175e9d87ab502ee1d5 (diff)
Add initial version
The initial version implements the basic functionality of the client/server communication and lease management. For now, one lease is created per valid connector (dependent on CRTC availablity). Bug-AGL: SPEC-3729 Signed-off-by: Damian Hobson-Garcia <dhobsong@igel.co.jp> Change-Id: I2b37a892742cc22bdc53a5172c8ad3d8a7bb5e66
Diffstat (limited to 'libdlmclient/docs')
-rw-r--r--libdlmclient/docs/Doxyfile.in9
-rw-r--r--libdlmclient/docs/meson.build21
2 files changed, 30 insertions, 0 deletions
diff --git a/libdlmclient/docs/Doxyfile.in b/libdlmclient/docs/Doxyfile.in
new file mode 100644
index 0000000..dce4244
--- /dev/null
+++ b/libdlmclient/docs/Doxyfile.in
@@ -0,0 +1,9 @@
+# General information
+PROJECT_NAME = "DRM Lease Manager Client Library"
+OUTPUT_DIRECTORY = @DOXYGEN_OUTPUT@
+INPUT = @README@ @CLIENT_HEADER_DIR@
+USE_MDFILE_AS_MAINPAGE = @README@
+FILE_PATTERNS = *.h
+GENERATE_LATEX = NO
+OPTIMIZE_OUTPUT_FOR_C = YES
+STRIP_FROM_PATH = @CLIENT_HEADER_DIR@
diff --git a/libdlmclient/docs/meson.build b/libdlmclient/docs/meson.build
new file mode 100644
index 0000000..563e5fb
--- /dev/null
+++ b/libdlmclient/docs/meson.build
@@ -0,0 +1,21 @@
+doxygen = find_program('doxygen', required : false)
+
+readme = join_paths(meson.source_root(), 'README.md')
+
+if get_option('enable-docs') and doxygen.found()
+ conf_data = configuration_data()
+ conf_data.set('README', readme)
+ conf_data.set('CLIENT_HEADER_DIR', dlmclient_header_dir)
+ conf_data.set('DOXYGEN_OUTPUT', meson.current_build_dir())
+ doxyfile = configure_file(
+ input: 'Doxyfile.in',
+ output: 'Doxyfile',
+ configuration: conf_data
+ )
+ custom_target('docs',
+ input: [doxyfile, readme, dlmclient_headers],
+ build_by_default: true,
+ command: [doxygen, '@INPUT0@'],
+ output: ['html']
+ )
+endif