summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--legacy/eet/Makefile.am8
-rw-r--r--legacy/eet/configure.in31
-rw-r--r--legacy/eet/doc/Doxyfile139
-rw-r--r--legacy/eet/doc/Makefile.am34
-rw-r--r--legacy/eet/eet.c.in2
-rw-r--r--legacy/eet/m4/doxygen.m473
6 files changed, 285 insertions, 2 deletions
diff --git a/legacy/eet/Makefile.am b/legacy/eet/Makefile.am
index 3137d2f37b..20512fac12 100644
--- a/legacy/eet/Makefile.am
+++ b/legacy/eet/Makefile.am
@@ -1,6 +1,12 @@
1## Process this file with automake to produce Makefile.in 1## Process this file with automake to produce Makefile.in
2 2
3SUBDIRS = src 3if BUILD_DOCS
4SUBDIRS_DOCS = doc
5else
6SUBDIRS_DOCS =
7endif
8
9SUBDIRS = src $(SUBDIRS_DOCS)
4 10
5MAINTAINERCLEANFILES = Makefile.in aclocal.m4 config.guess \ 11MAINTAINERCLEANFILES = Makefile.in aclocal.m4 config.guess \
6 config.h.in config.sub configure install-sh \ 12 config.h.in config.sub configure install-sh \
diff --git a/legacy/eet/configure.in b/legacy/eet/configure.in
index 3ef07cde2b..d1951c478a 100644
--- a/legacy/eet/configure.in
+++ b/legacy/eet/configure.in
@@ -123,9 +123,14 @@ dnl Set PACKAGE_SOURCE_DIR in config.h.
123packagesrcdir=`cd $srcdir && pwd` 123packagesrcdir=`cd $srcdir && pwd`
124AC_DEFINE_UNQUOTED(PACKAGE_SOURCE_DIR, "${packagesrcdir}", [Source code directory]) 124AC_DEFINE_UNQUOTED(PACKAGE_SOURCE_DIR, "${packagesrcdir}", [Source code directory])
125 125
126dnl Documentation
127AM_CHECK_DOXYGEN()
128
126AC_OUTPUT([ 129AC_OUTPUT([
127Makefile 130Makefile
128eet.pc 131eet.pc
132eet.c
133doc/Makefile
129src/Makefile 134src/Makefile
130src/lib/Makefile 135src/lib/Makefile
131src/bin/Makefile 136src/bin/Makefile
@@ -140,3 +145,29 @@ debian/changelog
140],[ 145],[
141chmod +x eet-config 146chmod +x eet-config
142]) 147])
148
149
150#####################################################################
151## Info
152
153echo
154echo
155echo
156echo "------------------------------------------------------------------------"
157echo "$PACKAGE $VERSION"
158echo "------------------------------------------------------------------------"
159echo
160echo "Configuration Options Summary:"
161echo
162echo " Build documentation..: $BUILD_DOCS"
163echo
164echo " Compilation..........: make"
165echo
166echo " Installation.........: make install"
167echo
168echo " prefix.........: $prefix"
169echo " binaries.......: $bindir"
170echo " libraries......: $libdir"
171echo " headers........: $includedir"
172echo " documentation..: $datadir/$PACKAGE/doc"
173echo
diff --git a/legacy/eet/doc/Doxyfile b/legacy/eet/doc/Doxyfile
new file mode 100644
index 0000000000..b553e4c31f
--- /dev/null
+++ b/legacy/eet/doc/Doxyfile
@@ -0,0 +1,139 @@
1PROJECT_NAME = Eet
2PROJECT_NUMBER =
3OUTPUT_DIRECTORY = .
4INPUT = ../eet.c ../src/lib
5IMAGE_PATH = img
6OUTPUT_LANGUAGE = English
7GENERATE_HTML = YES
8HTML_OUTPUT = html
9HTML_FILE_EXTENSION = .html
10HTML_HEADER = head.html
11HTML_FOOTER = foot.html
12HTML_STYLESHEET = eet.css
13HTML_ALIGN_MEMBERS = YES
14ENUM_VALUES_PER_LINE = 1
15GENERATE_HTMLHELP = NO
16CHM_FILE =
17HHC_LOCATION =
18GENERATE_CHI = NO
19BINARY_TOC = NO
20TOC_EXPAND = NO
21DISABLE_INDEX = NO
22EXTRACT_ALL = NO
23EXTRACT_PRIVATE = NO
24EXTRACT_STATIC = NO
25EXTRACT_LOCAL_CLASSES = NO
26HIDE_UNDOC_MEMBERS = YES
27HIDE_UNDOC_CLASSES = YES
28HIDE_FRIEND_COMPOUNDS = YES
29BRIEF_MEMBER_DESC = YES
30REPEAT_BRIEF = YES
31ALWAYS_DETAILED_SEC = NO
32INLINE_INHERITED_MEMB = NO
33FULL_PATH_NAMES = NO
34STRIP_FROM_PATH =
35INTERNAL_DOCS = NO
36STRIP_CODE_COMMENTS = YES
37CASE_SENSE_NAMES = YES
38SHORT_NAMES = NO
39HIDE_SCOPE_NAMES = NO
40VERBATIM_HEADERS = NO
41SHOW_INCLUDE_FILES = NO
42JAVADOC_AUTOBRIEF = YES
43MULTILINE_CPP_IS_BRIEF = NO
44DETAILS_AT_TOP = NO
45INHERIT_DOCS = YES
46INLINE_INFO = YES
47SORT_MEMBER_DOCS = YES
48DISTRIBUTE_GROUP_DOC = NO
49TAB_SIZE = 2
50GENERATE_TODOLIST = YES
51GENERATE_TESTLIST = YES
52GENERATE_BUGLIST = YES
53GENERATE_DEPRECATEDLIST= YES
54ALIASES =
55ENABLED_SECTIONS =
56MAX_INITIALIZER_LINES = 30
57OPTIMIZE_OUTPUT_FOR_C = YES
58OPTIMIZE_OUTPUT_JAVA = NO
59SHOW_USED_FILES = NO
60QUIET = NO
61WARNINGS = YES
62WARN_IF_UNDOCUMENTED = YES
63WARN_FORMAT = "$file:$line: $text"
64WARN_LOGFILE =
65FILE_PATTERNS =
66RECURSIVE = NO
67EXCLUDE =
68EXCLUDE_SYMLINKS = NO
69EXCLUDE_PATTERNS =
70EXAMPLE_PATH =
71EXAMPLE_PATTERNS =
72EXAMPLE_RECURSIVE = NO
73INPUT_FILTER =
74FILTER_SOURCE_FILES = NO
75SOURCE_BROWSER = NO
76INLINE_SOURCES = NO
77REFERENCED_BY_RELATION = YES
78REFERENCES_RELATION = YES
79ALPHABETICAL_INDEX = YES
80COLS_IN_ALPHA_INDEX = 2
81IGNORE_PREFIX =
82GENERATE_TREEVIEW = NO
83TREEVIEW_WIDTH = 250
84GENERATE_LATEX = YES
85LATEX_OUTPUT = latex
86LATEX_CMD_NAME = latex
87MAKEINDEX_CMD_NAME = makeindex
88COMPACT_LATEX = NO
89PAPER_TYPE = a4wide
90EXTRA_PACKAGES =
91LATEX_HEADER =
92PDF_HYPERLINKS = YES
93USE_PDFLATEX = NO
94LATEX_BATCHMODE = NO
95GENERATE_RTF = NO
96RTF_OUTPUT = rtf
97COMPACT_RTF = NO
98RTF_HYPERLINKS = NO
99RTF_STYLESHEET_FILE =
100RTF_EXTENSIONS_FILE =
101GENERATE_MAN = YES
102MAN_OUTPUT = man
103MAN_EXTENSION = .3
104MAN_LINKS = YES
105GENERATE_XML = YES
106XML_SCHEMA =
107XML_DTD =
108GENERATE_AUTOGEN_DEF = NO
109ENABLE_PREPROCESSING = YES
110MACRO_EXPANSION = NO
111EXPAND_ONLY_PREDEF = NO
112SEARCH_INCLUDES = NO
113INCLUDE_PATH =
114INCLUDE_FILE_PATTERNS =
115PREDEFINED =
116EXPAND_AS_DEFINED =
117SKIP_FUNCTION_MACROS = YES
118TAGFILES =
119GENERATE_TAGFILE =
120ALLEXTERNALS = NO
121EXTERNAL_GROUPS = YES
122PERL_PATH = /usr/bin/perl
123CLASS_DIAGRAMS = NO
124HIDE_UNDOC_RELATIONS = YES
125HAVE_DOT = NO
126CLASS_GRAPH = NO
127COLLABORATION_GRAPH = NO
128TEMPLATE_RELATIONS = NO
129INCLUDE_GRAPH = NO
130INCLUDED_BY_GRAPH = NO
131GRAPHICAL_HIERARCHY = NO
132DOT_IMAGE_FORMAT = png
133DOT_PATH =
134DOTFILE_DIRS =
135MAX_DOT_GRAPH_WIDTH = 512
136MAX_DOT_GRAPH_HEIGHT = 512
137GENERATE_LEGEND = YES
138DOT_CLEANUP = YES
139SEARCHENGINE = NO
diff --git a/legacy/eet/doc/Makefile.am b/legacy/eet/doc/Makefile.am
new file mode 100644
index 0000000000..db146449be
--- /dev/null
+++ b/legacy/eet/doc/Makefile.am
@@ -0,0 +1,34 @@
1
2if BUILD_DOCS
3
4# install documentation
5docdir = $(datadir)/$(PACKAGE)/doc
6
7all-local: doc-build.stamp
8
9# rule to remove all old created files
10doc-prepare.stamp:
11 @if test x"html" != x ; then \
12 rm -rf html/ latex/ man/ xml/; \
13 fi
14
15# rule to build documentation and copy necessary files
16doc-build.stamp: doc-prepare.stamp
17 @doxygen
18 @cp img/*.png html/
19
20# rule to install the documentation in $(docdir)
21install-data-local:
22 @if ! test -d $(datadir)/$(PACKAGE); then \
23 mkdir $(datadir)/$(PACKAGE); \
24 fi
25 @if ! test -d $(docdir); then \
26 mkdir $(docdir); \
27 fi
28 @cp -pr html/ man/ latex/ xml/ $(docdir)
29
30# rule to uninstall the documentation
31uninstall-local:
32 rm -rf $(docdir)
33
34endif
diff --git a/legacy/eet/eet.c.in b/legacy/eet/eet.c.in
index 81a7371942..78c9e1799e 100644
--- a/legacy/eet/eet.c.in
+++ b/legacy/eet/eet.c.in
@@ -9,7 +9,7 @@ These routines are used for Eet Library interaction
9 9
10@mainpage Eet Library Documentation 10@mainpage Eet Library Documentation
11@image html eet.png 11@image html eet.png
12@version 0.9.9 12@version @VERSION@
13@author Carsten Haitzler <raster@rasterman.com> 13@author Carsten Haitzler <raster@rasterman.com>
14@date 2000-2004 14@date 2000-2004
15 15
diff --git a/legacy/eet/m4/doxygen.m4 b/legacy/eet/m4/doxygen.m4
new file mode 100644
index 0000000000..32c134936a
--- /dev/null
+++ b/legacy/eet/m4/doxygen.m4
@@ -0,0 +1,73 @@
1dnl Configure script for doxygen
2dnl Vincent Torri 2005-22-09
3dnl
4dnl AM_CHECK_DOXYGEN([ACTION-IF-FOUND [, ACTION-IF-NOT-FOUND]])
5dnl Test for the doxygen program, and define BUILD_DOCS and DOXYGEN.
6dnl
7AC_DEFUN([AM_CHECK_DOXYGEN],
8 [
9 DOXYGEN="doxygen"
10 dnl
11 dnl Disable the build of the documentation
12 dnl
13 AC_ARG_ENABLE(
14 [build_docs],
15 AC_HELP_STRING(
16 [--disable-build-docs],
17 [Disable the build of the documentation]),
18 [if test "${disable_build_docs}" = "yes" ; then
19 enable_build_docs="no"
20 else
21 enable_build_docs="yes"
22 fi],
23 [enable_build_docs="yes"])
24 dnl
25 dnl Get the prefix where doxygen is installed.
26 dnl
27 AC_ARG_WITH(
28 [doxygen],
29 AC_HELP_STRING(
30 [--with-doxygen=FILE],
31 [doxygen program to use (eg /usr/bin/doxygen)]),
32 dnl
33 dnl Check the given doxygen program.
34 dnl
35 [DOXYGEN=${withval}
36 AC_CHECK_PROG(
37 [BUILD_DOCS],
38 [${DOXYGEN}],
39 [yes],
40 [no])
41 if test $BUILD_DOCS = no; then
42 echo "WARNING:"
43 echo "The doxygen program you specified:"
44 echo "$DOXYGEN"
45 echo "was not found. Please check the path and make sure "
46 echo "the program exists and is executable."
47 AC_MSG_WARN(
48 [Warning: no doxygen detected. Documentation will not be built])
49 fi],
50 [AC_CHECK_PROG(
51 [BUILD_DOCS],
52 [${DOXYGEN}],
53 [yes],
54 [no])
55 if test ${BUILD_DOCS} = no; then
56 echo "WARNING:"
57 echo "The doxygen program was not found in your execute"
58 echo "You may have doxygen installed somewhere not covered by your path."
59 echo ""
60 echo "If this is the case make sure you have the packages installed, AND"
61 echo "that the doxygen program is in your execute path (see your"
62 echo "shell's manual page on setting the \$PATH environment variable), OR"
63 echo "alternatively, specify the program to use with --with-doxygen."
64 AC_MSG_WARN(
65 [Warning: no doxygen detected. Documentation will not be built])
66 fi])
67 dnl
68 dnl Substitution
69 dnl
70 AC_SUBST([DOXYGEN])
71 AM_CONDITIONAL(BUILD_DOCS, test "x$BUILD_DOCS" = "xyes")
72 ])
73dnl End of doxygen.m4