summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJohannes Schanda <schanda@itestra.de>2013-09-05 14:52:30 +0200
committerJohannes Schanda <schanda@itestra.de>2013-09-05 14:52:30 +0200
commit982f52f3c8f6a1b31a45c4f4792ce9a76f01c020 (patch)
treec296ea0502228955e38f89d72f44919bd753c7da
parent0e0aee2aa57114693ba051b2524dcc400966e266 (diff)
downloadgenivi-common-api-runtime-982f52f3c8f6a1b31a45c4f4792ce9a76f01c020.tar.gz
Doxygen main page description
-rw-r--r--docx/01_mainpage.dox33
-rw-r--r--doxygen.cfg2
2 files changed, 34 insertions, 1 deletions
diff --git a/docx/01_mainpage.dox b/docx/01_mainpage.dox
new file mode 100644
index 0000000..e1d7b35
--- /dev/null
+++ b/docx/01_mainpage.dox
@@ -0,0 +1,33 @@
+/**
+ * Copyright (C) 2013 BMW AG
+ *
+ *
+ * This file is part of GENIVI Project CommonAPI.
+ *
+ * Contributions are licensed to the GENIVI Alliance under one or more
+ * Contribution License Agreements.
+ *
+ * \copyright
+ * This Source Code Form is subject to the terms of the
+ * Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with
+ * this file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * \author Juergen Gehring (juergen.gehring@bmw.de)
+ * \author Manfred Bathelt (manfred.bathelt@bmw.de)
+ *
+ */
+
+/*!
+\mainpage
+
+\par Usage information
+can be found in the README file in the source: http://git.projects.genivi.org/?p=ipc/common-api-runtime.git;a=blob;f=README;hb=HEAD
+
+\par More information
+can be found at https://collab.genivi.org/wiki/display/genivi/GENIVI+Home \n
+
+\par About CommonAPI-D-Bus
+CommonAPI C++ is an Inter Process Communication (IPC) API for C++, which enables applications to
+use different IPC middleware as backend without any changes to the application code.
+
+*/ \ No newline at end of file
diff --git a/doxygen.cfg b/doxygen.cfg
index 93c2ccd..bbae96b 100644
--- a/doxygen.cfg
+++ b/doxygen.cfg
@@ -655,7 +655,7 @@ WARN_LOGFILE =
# directories like "/usr/src/myproject". Separate the files or directories
# with spaces.
-INPUT = $(SRCDIR)
+INPUT = $(SRCDIR) docx
# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is