summaryrefslogtreecommitdiffstats
path: root/odk/docs/idl/Doxyfile
diff options
context:
space:
mode:
Diffstat (limited to 'odk/docs/idl/Doxyfile')
-rw-r--r--odk/docs/idl/Doxyfile48
1 files changed, 48 insertions, 0 deletions
diff --git a/odk/docs/idl/Doxyfile b/odk/docs/idl/Doxyfile
new file mode 100644
index 0000000000..008ec153b4
--- /dev/null
+++ b/odk/docs/idl/Doxyfile
@@ -0,0 +1,48 @@
+#
+# This file is part of the LibreOffice project.
+#
+# 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/.
+#
+
+PROJECT_BRIEF = %
+PROJECT_NAME = %
+OUTPUT_DIRECTORY = %
+STRIP_FROM_PATH = %
+INPUT = %
+RECURSIVE = YES
+
+GENERATE_HTML = YES
+HTML_OUTPUT = .
+HTML_TIMESTAMP = NO
+GENERATE_LATEX = NO
+
+QUIET = %
+WARNINGS = YES
+WARN_IF_DOC_ERROR = YES
+WARN_FORMAT = "$file:$line: $text"
+
+# Do this only on Windows - the MSI has some ridiculous path name length
+# restrictions - but not other platforms because short names are pretty random
+SHORT_NAMES = %
+# for windows? actually should NOT need this - no case collision in files!
+# note this changes filenames (uppercase letters translated to "_lowercase")
+#CASE_SENSE_NAMES = NO
+# this is bad because the directories have random names...
+#CREATE_SUBDIRS = YES
+# hmm... not sure if we want the source files in the output?
+#SHOW_USED_FILES = NO
+#SHOW_FILES = NO
+
+# ideally everything should be documented, but...
+EXTRACT_ALL = YES
+# first line is "brief" doc
+JAVADOC_AUTOBRIEF = YES
+# we want detailed description for everything, starting with "brief" doc
+REPEAT_BRIEF = YES
+ALWAYS_DETAILED_SEC = YES
+# by default members detail sections are prefixed with ns-qualified class
+# name which looks like overkill/clutter
+HIDE_SCOPE_NAMES = YES
+