summaryrefslogtreecommitdiff
path: root/doc
Unidiff
Diffstat (limited to 'doc') (more/less context) (ignore whitespace changes)
-rw-r--r--doc/Doxyfile_net224
-rwxr-xr-xdoc/Mainpage.dox5
-rwxr-xr-xdoc/generate_apidox8
3 files changed, 236 insertions, 1 deletions
diff --git a/doc/Doxyfile_net b/doc/Doxyfile_net
new file mode 100644
index 0000000..833fe02
--- a/dev/null
+++ b/doc/Doxyfile_net
@@ -0,0 +1,224 @@
1# Doxyfile 1.3.5
2
3#---------------------------------------------------------------------------
4# Project related configuration options
5#---------------------------------------------------------------------------
6PROJECT_NAME = "Networksettings API"
7PROJECT_NUMBER = "Version 1.0"
8OUTPUT_DIRECTORY = ../../../apidocs
9OUTPUT_LANGUAGE = English
10USE_WINDOWS_ENCODING = NO
11BRIEF_MEMBER_DESC = YES
12REPEAT_BRIEF = YES
13ABBREVIATE_BRIEF =
14ALWAYS_DETAILED_SEC = YES
15INLINE_INHERITED_MEMB = NO
16FULL_PATH_NAMES = NO
17STRIP_FROM_PATH =
18SHORT_NAMES = NO
19JAVADOC_AUTOBRIEF = YES
20MULTILINE_CPP_IS_BRIEF = NO
21DETAILS_AT_TOP = NO
22INHERIT_DOCS = YES
23DISTRIBUTE_GROUP_DOC = NO
24TAB_SIZE = 4
25ALIASES = libdoc=@mainpage \
26 sect=<p><b> \
27 reimplemented= \
28 "deprecated=<b>This class or method is obsolete, it is provided for compatibility only.</b>" \
29 obsolete=@deprecated \
30 ref= \
31 slash=/
32OPTIMIZE_OUTPUT_FOR_C = NO
33OPTIMIZE_OUTPUT_JAVA = NO
34SUBGROUPING = YES
35#---------------------------------------------------------------------------
36# Build related configuration options
37#---------------------------------------------------------------------------
38EXTRACT_ALL = NO
39EXTRACT_PRIVATE = NO
40EXTRACT_STATIC = YES
41EXTRACT_LOCAL_CLASSES = NO
42HIDE_UNDOC_MEMBERS = NO
43HIDE_UNDOC_CLASSES = YES
44HIDE_FRIEND_COMPOUNDS = NO
45HIDE_IN_BODY_DOCS = NO
46INTERNAL_DOCS = NO
47CASE_SENSE_NAMES = YES
48HIDE_SCOPE_NAMES = NO
49SHOW_INCLUDE_FILES = YES
50INLINE_INFO = YES
51SORT_MEMBER_DOCS = NO
52GENERATE_TODOLIST = YES
53GENERATE_TESTLIST = YES
54GENERATE_BUGLIST = YES
55GENERATE_DEPRECATEDLIST= YES
56ENABLED_SECTIONS =
57MAX_INITIALIZER_LINES = 30
58SHOW_USED_FILES = YES
59#---------------------------------------------------------------------------
60# configuration options related to warning and progress messages
61#---------------------------------------------------------------------------
62QUIET = YES
63WARNINGS = YES
64WARN_IF_UNDOCUMENTED = YES
65WARN_IF_DOC_ERROR = YES
66WARN_FORMAT = "$file:$line: $text"
67WARN_LOGFILE = Dox-Warning
68#---------------------------------------------------------------------------
69# configuration options related to the input files
70#---------------------------------------------------------------------------
71INPUT = . \
72 interfaces
73FILE_PATTERNS = *.h \
74 *.cpp \
75 *.cc \
76 *.hpp
77RECURSIVE = NO
78EXCLUDE =
79EXCLUDE_SYMLINKS = NO
80EXCLUDE_PATTERNS = *.moc.* \
81 moc* \
82 *.all_cpp.* \
83 *unload.* \
84 */test/* \
85 */tests/*
86EXAMPLE_PATH =
87EXAMPLE_PATTERNS =
88EXAMPLE_RECURSIVE = NO
89IMAGE_PATH = ../../../apidocs/api
90INPUT_FILTER =
91FILTER_SOURCE_FILES = NO
92#---------------------------------------------------------------------------
93# configuration options related to source browsing
94#---------------------------------------------------------------------------
95SOURCE_BROWSER = YES
96INLINE_SOURCES = NO
97STRIP_CODE_COMMENTS = YES
98REFERENCED_BY_RELATION = YES
99REFERENCES_RELATION = YES
100VERBATIM_HEADERS = YES
101#---------------------------------------------------------------------------
102# configuration options related to the alphabetical class index
103#---------------------------------------------------------------------------
104ALPHABETICAL_INDEX = YES
105COLS_IN_ALPHA_INDEX = 3
106IGNORE_PREFIX = O
107#---------------------------------------------------------------------------
108# configuration options related to the HTML output
109#---------------------------------------------------------------------------
110GENERATE_HTML = YES
111HTML_OUTPUT = network/html
112HTML_FILE_EXTENSION = .html
113HTML_HEADER = ../../../apidocs/common/header.html
114HTML_FOOTER = ../../../apidocs/common/footer.html
115HTML_STYLESHEET = ../../../apidocs/common/doxygen.css
116HTML_ALIGN_MEMBERS = YES
117GENERATE_HTMLHELP = NO
118CHM_FILE =
119HHC_LOCATION =
120GENERATE_CHI = NO
121BINARY_TOC = NO
122TOC_EXPAND = NO
123DISABLE_INDEX = YES
124ENUM_VALUES_PER_LINE = 4
125GENERATE_TREEVIEW = NO
126TREEVIEW_WIDTH = 250
127#---------------------------------------------------------------------------
128# configuration options related to the LaTeX output
129#---------------------------------------------------------------------------
130GENERATE_LATEX = NO
131LATEX_OUTPUT = libopie/latex
132LATEX_CMD_NAME = latex
133MAKEINDEX_CMD_NAME = makeindex
134COMPACT_LATEX = NO
135PAPER_TYPE = a4wide
136EXTRA_PACKAGES =
137LATEX_HEADER =
138PDF_HYPERLINKS = NO
139USE_PDFLATEX = NO
140LATEX_BATCHMODE = NO
141LATEX_HIDE_INDICES = NO
142#---------------------------------------------------------------------------
143# configuration options related to the RTF output
144#---------------------------------------------------------------------------
145GENERATE_RTF = NO
146RTF_OUTPUT = libopie/rtf
147COMPACT_RTF = NO
148RTF_HYPERLINKS = NO
149RTF_STYLESHEET_FILE =
150RTF_EXTENSIONS_FILE =
151#---------------------------------------------------------------------------
152# configuration options related to the man page output
153#---------------------------------------------------------------------------
154GENERATE_MAN = NO
155MAN_OUTPUT = libopie/man
156MAN_EXTENSION = .kde3
157MAN_LINKS = YES
158#---------------------------------------------------------------------------
159# configuration options related to the XML output
160#---------------------------------------------------------------------------
161GENERATE_XML = NO
162XML_OUTPUT = xml
163XML_SCHEMA =
164XML_DTD =
165XML_PROGRAMLISTING = YES
166#---------------------------------------------------------------------------
167# configuration options for the AutoGen Definitions output
168#---------------------------------------------------------------------------
169GENERATE_AUTOGEN_DEF = NO
170#---------------------------------------------------------------------------
171# configuration options related to the Perl module output
172#---------------------------------------------------------------------------
173GENERATE_PERLMOD = NO
174PERLMOD_LATEX = NO
175PERLMOD_PRETTY = YES
176PERLMOD_MAKEVAR_PREFIX =
177#---------------------------------------------------------------------------
178# Configuration options related to the preprocessor
179#---------------------------------------------------------------------------
180ENABLE_PREPROCESSING = YES
181MACRO_EXPANSION = NO
182EXPAND_ONLY_PREDEF = NO
183SEARCH_INCLUDES = YES
184INCLUDE_PATH =
185INCLUDE_FILE_PATTERNS =
186PREDEFINED = QT_VERSION=305
187EXPAND_AS_DEFINED =
188SKIP_FUNCTION_MACROS = YES
189#---------------------------------------------------------------------------
190# Configuration::addtions related to external references
191#---------------------------------------------------------------------------
192TAGFILES = ../../../apidocs/qt/qt.tag=../../qt \
193 ../../../apidocs/libopie/libopie.tag=../../libopie/html \
194 ../../../apidocs/libqpe/libqpe.tag=../../libqpe/html
195GENERATE_TAGFILE = ../../../apidocs/network/net.tag
196ALLEXTERNALS = NO
197EXTERNAL_GROUPS = NO
198PERL_PATH =
199#---------------------------------------------------------------------------
200# Configuration options related to the dot tool
201#---------------------------------------------------------------------------
202CLASS_DIAGRAMS = YES
203HIDE_UNDOC_RELATIONS = NO
204HAVE_DOT = YES
205CLASS_GRAPH = YES
206COLLABORATION_GRAPH = YES
207UML_LOOK = NO
208TEMPLATE_RELATIONS = YES
209INCLUDE_GRAPH = YES
210INCLUDED_BY_GRAPH = YES
211CALL_GRAPH = NO
212GRAPHICAL_HIERARCHY = NO
213DOT_IMAGE_FORMAT = png
214DOT_PATH =
215DOTFILE_DIRS =
216MAX_DOT_GRAPH_WIDTH = 800
217MAX_DOT_GRAPH_HEIGHT = 1024
218MAX_DOT_GRAPH_DEPTH = 0
219GENERATE_LEGEND = YES
220DOT_CLEANUP = YES
221#---------------------------------------------------------------------------
222# Configuration::addtions related to the search engine
223#---------------------------------------------------------------------------
224SEARCHENGINE = NO
diff --git a/doc/Mainpage.dox b/doc/Mainpage.dox
index 4fb0d49..9dcf52d 100755
--- a/doc/Mainpage.dox
+++ b/doc/Mainpage.dox
@@ -15,13 +15,16 @@
15 * - <a href="libopie/html/index.html"><b>libopie</b></a> 15 * - <a href="libopie/html/index.html"><b>libopie</b></a>
16 * (<a href="libopie/html/classes.html">classes</a>)\n 16 * (<a href="libopie/html/classes.html">classes</a>)\n
17 * <i>libopie</i> 17 * <i>libopie</i>
18 * - <a href="pim/html/index.html"><b>PIM</b></a> 18 * - <a href="pim/html/index.html"><b>PIM</b></a>
19 * (<a href="pim/html/classes.html">classes</a>)\n 19 * (<a href="pim/html/classes.html">classes</a>)\n
20 * <i>Libopie PIM</i> 20 * <i>Libopie PIM</i>
21 * 21 * - <a href="network/html/index.html"><b>Network Settings Modules</b></a>
22 * (<a href="network/html/classes.html">classes</a>)\n
23 * <i>Networksettings</i>
24 *
22 */ 25 */
23 26
24/** 27/**
25 * @page search Search the API documentation 28 * @page search Search the API documentation
26 * 29 *
27 * <br>Under construction. 30 * <br>Under construction.
diff --git a/doc/generate_apidox b/doc/generate_apidox
index db77e20..f6eadc7 100755
--- a/doc/generate_apidox
+++ b/doc/generate_apidox
@@ -11,12 +11,13 @@ mkdir $OPIEDIR/apidocs
11mkdir $OPIEDIR/apidocs/api 11mkdir $OPIEDIR/apidocs/api
12mkdir $OPIEDIR/apidocs/common 12mkdir $OPIEDIR/apidocs/common
13mkdir $OPIEDIR/apidocs/qt 13mkdir $OPIEDIR/apidocs/qt
14mkdir $OPIEDIR/apidocs/libqpe 14mkdir $OPIEDIR/apidocs/libqpe
15mkdir $OPIEDIR/apidocs/libopie 15mkdir $OPIEDIR/apidocs/libopie
16mkdir $OPIEDIR/apidocs/pim 16mkdir $OPIEDIR/apidocs/pim
17mkdir $OPIEDIR/apidocs/network
17 18
18# now copy qt doc 19# now copy qt doc
19echo "Scanning and copying QT docu" 20echo "Scanning and copying QT docu"
20cp -R $QTDIR/doc/html/* $OPIEDIR/apidocs/qt 21cp -R $QTDIR/doc/html/* $OPIEDIR/apidocs/qt
21doxytag -t $OPIEDIR/apidocs/qt/qt.tag $OPIEDIR/apidocs/qt 22doxytag -t $OPIEDIR/apidocs/qt/qt.tag $OPIEDIR/apidocs/qt
22 23
@@ -39,12 +40,19 @@ echo "Creating docu for PIM"
39# now it's time for libopie/pim 40# now it's time for libopie/pim
40cp $OPIEDIR/doc/Doxyfile_pim $OPIEDIR/libopie/pim/Doxyfile 41cp $OPIEDIR/doc/Doxyfile_pim $OPIEDIR/libopie/pim/Doxyfile
41cd $OPIEDIR/libopie/pim 42cd $OPIEDIR/libopie/pim
42doxygen Doxyfile 43doxygen Doxyfile
43rm -f Doxyfile 44rm -f Doxyfile
44 45
46echo "Creating docu for NetworkSettings"
47# now do networksettings
48cp $OPIEDIR/doc/Doxyfile_net $OPIEDIR/noncore/settings/networksettings/Doxyfile
49cd $OPIEDIR/noncore/settings/networksettings
50doxygen Doxyfile
51rm -f Doxyfile
52
45echo "Making mainpage" 53echo "Making mainpage"
46# now generate the mainpage 54# now generate the mainpage
47cp $OPIEDIR/doc/Doxyfile_main $OPIEDIR/Doxyfile 55cp $OPIEDIR/doc/Doxyfile_main $OPIEDIR/Doxyfile
48cp $OPIEDIR/doc/Mainpage.dox $OPIEDIR/ 56cp $OPIEDIR/doc/Mainpage.dox $OPIEDIR/
49cd $OPIEDIR 57cd $OPIEDIR
50doxygen Doxyfile 58doxygen Doxyfile