summaryrefslogtreecommitdiff
authorzecke <zecke>2004-02-08 16:32:22 (UTC)
committer zecke <zecke>2004-02-08 16:32:22 (UTC)
commit2dc8add65c44b3dd240cf2bd3c276c3c0155f46b (patch) (side-by-side diff)
treecb04cd52fa1b2850c3ae3f086c523172ad035d0e
parent11324fcf42d984579080ebe474d50258d39adf4f (diff)
downloadopie-2dc8add65c44b3dd240cf2bd3c276c3c0155f46b.zip
opie-2dc8add65c44b3dd240cf2bd3c276c3c0155f46b.tar.gz
opie-2dc8add65c44b3dd240cf2bd3c276c3c0155f46b.tar.bz2
Networksettings additions
Diffstat (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 @@
+# Doxyfile 1.3.5
+
+#---------------------------------------------------------------------------
+# Project related configuration options
+#---------------------------------------------------------------------------
+PROJECT_NAME = "Networksettings API"
+PROJECT_NUMBER = "Version 1.0"
+OUTPUT_DIRECTORY = ../../../apidocs
+OUTPUT_LANGUAGE = English
+USE_WINDOWS_ENCODING = NO
+BRIEF_MEMBER_DESC = YES
+REPEAT_BRIEF = YES
+ABBREVIATE_BRIEF =
+ALWAYS_DETAILED_SEC = YES
+INLINE_INHERITED_MEMB = NO
+FULL_PATH_NAMES = NO
+STRIP_FROM_PATH =
+SHORT_NAMES = NO
+JAVADOC_AUTOBRIEF = YES
+MULTILINE_CPP_IS_BRIEF = NO
+DETAILS_AT_TOP = NO
+INHERIT_DOCS = YES
+DISTRIBUTE_GROUP_DOC = NO
+TAB_SIZE = 4
+ALIASES = libdoc=@mainpage \
+ sect=<p><b> \
+ reimplemented= \
+ "deprecated=<b>This class or method is obsolete, it is provided for compatibility only.</b>" \
+ obsolete=@deprecated \
+ ref= \
+ slash=/
+OPTIMIZE_OUTPUT_FOR_C = NO
+OPTIMIZE_OUTPUT_JAVA = NO
+SUBGROUPING = YES
+#---------------------------------------------------------------------------
+# Build related configuration options
+#---------------------------------------------------------------------------
+EXTRACT_ALL = NO
+EXTRACT_PRIVATE = NO
+EXTRACT_STATIC = YES
+EXTRACT_LOCAL_CLASSES = NO
+HIDE_UNDOC_MEMBERS = NO
+HIDE_UNDOC_CLASSES = YES
+HIDE_FRIEND_COMPOUNDS = NO
+HIDE_IN_BODY_DOCS = NO
+INTERNAL_DOCS = NO
+CASE_SENSE_NAMES = YES
+HIDE_SCOPE_NAMES = NO
+SHOW_INCLUDE_FILES = YES
+INLINE_INFO = YES
+SORT_MEMBER_DOCS = NO
+GENERATE_TODOLIST = YES
+GENERATE_TESTLIST = YES
+GENERATE_BUGLIST = YES
+GENERATE_DEPRECATEDLIST= YES
+ENABLED_SECTIONS =
+MAX_INITIALIZER_LINES = 30
+SHOW_USED_FILES = YES
+#---------------------------------------------------------------------------
+# configuration options related to warning and progress messages
+#---------------------------------------------------------------------------
+QUIET = YES
+WARNINGS = YES
+WARN_IF_UNDOCUMENTED = YES
+WARN_IF_DOC_ERROR = YES
+WARN_FORMAT = "$file:$line: $text"
+WARN_LOGFILE = Dox-Warning
+#---------------------------------------------------------------------------
+# configuration options related to the input files
+#---------------------------------------------------------------------------
+INPUT = . \
+ interfaces
+FILE_PATTERNS = *.h \
+ *.cpp \
+ *.cc \
+ *.hpp
+RECURSIVE = NO
+EXCLUDE =
+EXCLUDE_SYMLINKS = NO
+EXCLUDE_PATTERNS = *.moc.* \
+ moc* \
+ *.all_cpp.* \
+ *unload.* \
+ */test/* \
+ */tests/*
+EXAMPLE_PATH =
+EXAMPLE_PATTERNS =
+EXAMPLE_RECURSIVE = NO
+IMAGE_PATH = ../../../apidocs/api
+INPUT_FILTER =
+FILTER_SOURCE_FILES = NO
+#---------------------------------------------------------------------------
+# configuration options related to source browsing
+#---------------------------------------------------------------------------
+SOURCE_BROWSER = YES
+INLINE_SOURCES = NO
+STRIP_CODE_COMMENTS = YES
+REFERENCED_BY_RELATION = YES
+REFERENCES_RELATION = YES
+VERBATIM_HEADERS = YES
+#---------------------------------------------------------------------------
+# configuration options related to the alphabetical class index
+#---------------------------------------------------------------------------
+ALPHABETICAL_INDEX = YES
+COLS_IN_ALPHA_INDEX = 3
+IGNORE_PREFIX = O
+#---------------------------------------------------------------------------
+# configuration options related to the HTML output
+#---------------------------------------------------------------------------
+GENERATE_HTML = YES
+HTML_OUTPUT = network/html
+HTML_FILE_EXTENSION = .html
+HTML_HEADER = ../../../apidocs/common/header.html
+HTML_FOOTER = ../../../apidocs/common/footer.html
+HTML_STYLESHEET = ../../../apidocs/common/doxygen.css
+HTML_ALIGN_MEMBERS = YES
+GENERATE_HTMLHELP = NO
+CHM_FILE =
+HHC_LOCATION =
+GENERATE_CHI = NO
+BINARY_TOC = NO
+TOC_EXPAND = NO
+DISABLE_INDEX = YES
+ENUM_VALUES_PER_LINE = 4
+GENERATE_TREEVIEW = NO
+TREEVIEW_WIDTH = 250
+#---------------------------------------------------------------------------
+# configuration options related to the LaTeX output
+#---------------------------------------------------------------------------
+GENERATE_LATEX = NO
+LATEX_OUTPUT = libopie/latex
+LATEX_CMD_NAME = latex
+MAKEINDEX_CMD_NAME = makeindex
+COMPACT_LATEX = NO
+PAPER_TYPE = a4wide
+EXTRA_PACKAGES =
+LATEX_HEADER =
+PDF_HYPERLINKS = NO
+USE_PDFLATEX = NO
+LATEX_BATCHMODE = NO
+LATEX_HIDE_INDICES = NO
+#---------------------------------------------------------------------------
+# configuration options related to the RTF output
+#---------------------------------------------------------------------------
+GENERATE_RTF = NO
+RTF_OUTPUT = libopie/rtf
+COMPACT_RTF = NO
+RTF_HYPERLINKS = NO
+RTF_STYLESHEET_FILE =
+RTF_EXTENSIONS_FILE =
+#---------------------------------------------------------------------------
+# configuration options related to the man page output
+#---------------------------------------------------------------------------
+GENERATE_MAN = NO
+MAN_OUTPUT = libopie/man
+MAN_EXTENSION = .kde3
+MAN_LINKS = YES
+#---------------------------------------------------------------------------
+# configuration options related to the XML output
+#---------------------------------------------------------------------------
+GENERATE_XML = NO
+XML_OUTPUT = xml
+XML_SCHEMA =
+XML_DTD =
+XML_PROGRAMLISTING = YES
+#---------------------------------------------------------------------------
+# configuration options for the AutoGen Definitions output
+#---------------------------------------------------------------------------
+GENERATE_AUTOGEN_DEF = NO
+#---------------------------------------------------------------------------
+# configuration options related to the Perl module output
+#---------------------------------------------------------------------------
+GENERATE_PERLMOD = NO
+PERLMOD_LATEX = NO
+PERLMOD_PRETTY = YES
+PERLMOD_MAKEVAR_PREFIX =
+#---------------------------------------------------------------------------
+# Configuration options related to the preprocessor
+#---------------------------------------------------------------------------
+ENABLE_PREPROCESSING = YES
+MACRO_EXPANSION = NO
+EXPAND_ONLY_PREDEF = NO
+SEARCH_INCLUDES = YES
+INCLUDE_PATH =
+INCLUDE_FILE_PATTERNS =
+PREDEFINED = QT_VERSION=305
+EXPAND_AS_DEFINED =
+SKIP_FUNCTION_MACROS = YES
+#---------------------------------------------------------------------------
+# Configuration::addtions related to external references
+#---------------------------------------------------------------------------
+TAGFILES = ../../../apidocs/qt/qt.tag=../../qt \
+ ../../../apidocs/libopie/libopie.tag=../../libopie/html \
+ ../../../apidocs/libqpe/libqpe.tag=../../libqpe/html
+GENERATE_TAGFILE = ../../../apidocs/network/net.tag
+ALLEXTERNALS = NO
+EXTERNAL_GROUPS = NO
+PERL_PATH =
+#---------------------------------------------------------------------------
+# Configuration options related to the dot tool
+#---------------------------------------------------------------------------
+CLASS_DIAGRAMS = YES
+HIDE_UNDOC_RELATIONS = NO
+HAVE_DOT = YES
+CLASS_GRAPH = YES
+COLLABORATION_GRAPH = YES
+UML_LOOK = NO
+TEMPLATE_RELATIONS = YES
+INCLUDE_GRAPH = YES
+INCLUDED_BY_GRAPH = YES
+CALL_GRAPH = NO
+GRAPHICAL_HIERARCHY = NO
+DOT_IMAGE_FORMAT = png
+DOT_PATH =
+DOTFILE_DIRS =
+MAX_DOT_GRAPH_WIDTH = 800
+MAX_DOT_GRAPH_HEIGHT = 1024
+MAX_DOT_GRAPH_DEPTH = 0
+GENERATE_LEGEND = YES
+DOT_CLEANUP = YES
+#---------------------------------------------------------------------------
+# Configuration::addtions related to the search engine
+#---------------------------------------------------------------------------
+SEARCHENGINE = NO
diff --git a/doc/Mainpage.dox b/doc/Mainpage.dox
index 4fb0d49..9dcf52d 100755
--- a/doc/Mainpage.dox
+++ b/doc/Mainpage.dox
@@ -1,30 +1,33 @@
/**
* @mainpage The OPIE API Reference
*
* This section contains the OPIE online class reference for the current
* development version of OPIE. You can also download (???&nbsp;MB)
* the complete API documentation. Additionally, you can subscribe or
* read the mailing lists for any additions and/or modifications to the API.
*
* - <a href="qt/index.html"><b>qt</b></a>
* (<a href="qt/classes.html">classes</a>)\n
* <i>Qt classes</i>
* - <a href="libqpe/html/index.html"><b>Qtopia library</b></a>
* (<a href="libqpe/html/classes.html">classes</a>)\n
* <i>Qtopia lib</i>
* - <a href="libopie/html/index.html"><b>libopie</b></a>
* (<a href="libopie/html/classes.html">classes</a>)\n
* <i>libopie</i>
* - <a href="pim/html/index.html"><b>PIM</b></a>
* (<a href="pim/html/classes.html">classes</a>)\n
* <i>Libopie PIM</i>
- *
+ * - <a href="network/html/index.html"><b>Network Settings Modules</b></a>
+ * (<a href="network/html/classes.html">classes</a>)\n
+ * <i>Networksettings</i>
+ *
*/
/**
* @page search Search the API documentation
*
* <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
@@ -1,54 +1,62 @@
#!/bin/sh
# small shell script to generate our API docs
# it'll copy over qt
#
# create directory structure
echo "Creating directory structure"
rm -rf $OPIEDIR/apidocs
mkdir $OPIEDIR/apidocs
mkdir $OPIEDIR/apidocs/api
mkdir $OPIEDIR/apidocs/common
mkdir $OPIEDIR/apidocs/qt
mkdir $OPIEDIR/apidocs/libqpe
mkdir $OPIEDIR/apidocs/libopie
mkdir $OPIEDIR/apidocs/pim
+mkdir $OPIEDIR/apidocs/network
# now copy qt doc
echo "Scanning and copying QT docu"
cp -R $QTDIR/doc/html/* $OPIEDIR/apidocs/qt
doxytag -t $OPIEDIR/apidocs/qt/qt.tag $OPIEDIR/apidocs/qt
cp -r $OPIEDIR/doc/common/* $OPIEDIR/apidocs/common
# now start with libqpe
echo "Creating docu for qpe"
cp $OPIEDIR/doc/Doxyfile_libqpe $OPIEDIR/library/Doxyfile
cd $OPIEDIR/library
doxygen Doxyfile
rm -f Doxyfile
# now do libopie
echo "Creating docu for libopie"
cp $OPIEDIR/doc/Doxyfile_libopie $OPIEDIR/libopie/Doxyfile
cd $OPIEDIR/libopie
doxygen Doxyfile
rm -f Doxyfile
echo "Creating docu for PIM"
# now it's time for libopie/pim
cp $OPIEDIR/doc/Doxyfile_pim $OPIEDIR/libopie/pim/Doxyfile
cd $OPIEDIR/libopie/pim
doxygen Doxyfile
rm -f Doxyfile
+echo "Creating docu for NetworkSettings"
+# now do networksettings
+cp $OPIEDIR/doc/Doxyfile_net $OPIEDIR/noncore/settings/networksettings/Doxyfile
+cd $OPIEDIR/noncore/settings/networksettings
+doxygen Doxyfile
+rm -f Doxyfile
+
echo "Making mainpage"
# now generate the mainpage
cp $OPIEDIR/doc/Doxyfile_main $OPIEDIR/Doxyfile
cp $OPIEDIR/doc/Mainpage.dox $OPIEDIR/
cd $OPIEDIR
doxygen Doxyfile
rm -f Doxyfile
rm -f Mainpage.dox
echo "Done with generation!!! hopefully grin"