Skip to content

Commit 9b49d0e

Browse files
author
blinkseb
committed
updated: doxygen "build" script.
git-svn-id: https://xbmc.svn.sourceforge.net/svnroot/xbmc/trunk@28615 568bbfeb-2a22-0410-94d2-cc84cf5bfa90
1 parent 6ad3267 commit 9b49d0e

File tree

3 files changed

+158
-176
lines changed

3 files changed

+158
-176
lines changed

doxygen_resources/Doxyfile.doxy

+58-10
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Doxyfile 1.6.1
1+
# Doxyfile 1.6.3
22

33
# This file describes the settings to be used by the documentation system
44
# doxygen (www.doxygen.org) for a project
@@ -397,6 +397,12 @@ HIDE_SCOPE_NAMES = NO
397397

398398
SHOW_INCLUDE_FILES = YES
399399

400+
# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
401+
# will list include files with double quotes in the documentation
402+
# rather than with sharp brackets.
403+
404+
FORCE_LOCAL_INCLUDES = NO
405+
400406
# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
401407
# is inserted in the documentation for inline members.
402408

@@ -584,7 +590,7 @@ WARN_LOGFILE =
584590
# directories like "/usr/src/myproject". Separate the files or directories
585591
# with spaces.
586592

587-
INPUT = ../xbmc/utils \
593+
INPUT = ../xbmc \
588594
../guilib \
589595
.
590596

@@ -645,7 +651,8 @@ RECURSIVE = YES
645651
# excluded from the INPUT source files. This way you can easily exclude a
646652
# subdirectory from a directory tree whose root is specified with the INPUT tag.
647653

648-
EXCLUDE = ../guilib/tinyXML
654+
EXCLUDE = ../guilib/tinyXML \
655+
../xbmc/lib
649656

650657
# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
651658
# directories that are symbolic links (a Unix filesystem feature) are excluded
@@ -659,7 +666,11 @@ EXCLUDE_SYMLINKS = NO
659666
# against the file with absolute path, so to exclude all test directories
660667
# for example use the pattern */test/*
661668

662-
EXCLUDE_PATTERNS = */.svn/*
669+
EXCLUDE_PATTERNS = */.svn/* \
670+
*/.svn \
671+
*/lib*/* \
672+
*/*Codec/* \
673+
doxygen.hpp
663674

664675
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
665676
# (namespaces, classes, functions, etc.) that should be excluded from the
@@ -840,6 +851,12 @@ HTML_FOOTER =
840851

841852
HTML_STYLESHEET =
842853

854+
# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
855+
# page will contain the date and time when the page was generated. Setting
856+
# this to NO can help when comparing the output of multiple runs.
857+
858+
HTML_TIMESTAMP = YES
859+
843860
# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
844861
# files or namespaces will be aligned in HTML using tables. If set to
845862
# NO a bullet list will be used.
@@ -941,7 +958,7 @@ QCH_FILE =
941958
# Qt Help Project output. For more information please see
942959
# http://doc.trolltech.com/qthelpproject.html#namespace
943960

944-
QHP_NAMESPACE =
961+
QHP_NAMESPACE = org.doxygen.Project
945962

946963
# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
947964
# Qt Help Project output. For more information please see
@@ -973,6 +990,23 @@ QHP_SECT_FILTER_ATTRS =
973990

974991
QHG_LOCATION =
975992

993+
# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
994+
# will be generated, which together with the HTML files, form an Eclipse help
995+
# plugin. To install this plugin and make it available under the help contents
996+
# menu in Eclipse, the contents of the directory containing the HTML and XML
997+
# files needs to be copied into the plugins directory of eclipse. The name of
998+
# the directory within the plugins directory should be the same as
999+
# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
1000+
# the help appears.
1001+
1002+
GENERATE_ECLIPSEHELP = NO
1003+
1004+
# A unique identifier for the eclipse help plugin. When installing the plugin
1005+
# the directory name containing the HTML and XML files should also have
1006+
# this name.
1007+
1008+
ECLIPSE_DOC_ID = org.doxygen.Project
1009+
9761010
# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
9771011
# top of each HTML page. The value NO (the default) enables the index and
9781012
# the value YES disables it.
@@ -1013,15 +1047,26 @@ TREEVIEW_WIDTH = 250
10131047

10141048
FORMULA_FONTSIZE = 10
10151049

1016-
# When the SEARCHENGINE tag is enable doxygen will generate a search box
1050+
# When the SEARCHENGINE tag is enabled doxygen will generate a search box
10171051
# for the HTML output. The underlying search engine uses javascript
10181052
# and DHTML and should work on any modern browser. Note that when using
1019-
# HTML help (GENERATE_HTMLHELP) or Qt help (GENERATE_QHP)
1020-
# there is already a search function so this one should typically
1021-
# be disabled.
1053+
# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets
1054+
# (GENERATE_DOCSET) there is already a search function so this one should
1055+
# typically be disabled. For large projects the javascript based search engine
1056+
# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
10221057

10231058
SEARCHENGINE = NO
10241059

1060+
# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1061+
# implemented using a PHP enabled web server instead of at the web client
1062+
# using Javascript. Doxygen will generate the search PHP script and index
1063+
# file to put on the web server. The advantage of the server
1064+
# based approach is that it scales better to large projects and allows
1065+
# full text search. The disadvances is that it is more difficult to setup
1066+
# and does not have live searching capabilities.
1067+
1068+
SERVER_BASED_SEARCH = NO
1069+
10251070
#---------------------------------------------------------------------------
10261071
# configuration options related to the LaTeX output
10271072
#---------------------------------------------------------------------------
@@ -1038,7 +1083,10 @@ GENERATE_LATEX = NO
10381083
LATEX_OUTPUT = latex
10391084

10401085
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1041-
# invoked. If left blank `latex' will be used as the default command name.
1086+
# invoked. If left blank `latex' will be used as the default command name.
1087+
# Note that when enabling USE_PDFLATEX this option is only used for
1088+
# generating bitmaps for formulas in the HTML output, but not in the
1089+
# Makefile that is written to the output directory.
10421090

10431091
LATEX_CMD_NAME = latex
10441092

doxygen_resources/pages/mainpage.dox

+100-3
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,110 @@
99
and we welcome any and all input to documenting it further. Documentation serves both to help
1010
newcomers get to grips with the source quickly, and to highlight possible deficiencies in the
1111
code or interfaces.
12-
13-
Currently the doxygen configuration file is set to only document the "xbmc\utils" directory,
14-
though the ultimate goal is to document the public interface of everything.
1512

1613
Any help/suggestions are more than welcome.
1714

1815
\section doxy_whatisxbmc What is XBMC?
1916
XBMC is a free, open source (GPL) multimedia player that runs on Linux, Mac OS X (10.4 and later),
2017
AppleTV and Windows. See http://xbmc.org for more details.
2118
*/
19+
20+
// Groups definition
21+
22+
///////////////////////////////////////
23+
//
24+
// xbmc project
25+
//
26+
///////////////////////////////////////
27+
28+
/*!
29+
\defgroup windows XBMC windows
30+
31+
XBMC windows
32+
*/
33+
34+
/*!
35+
\defgroup music Music info
36+
37+
Elements used in my music
38+
*/
39+
40+
41+
//////////////////////////////////////
42+
//
43+
// guilib project
44+
//
45+
//////////////////////////////////////
46+
47+
/*!
48+
\defgroup guilib guilib classes
49+
50+
guilib classes
51+
*/
52+
53+
/*!
54+
\defgroup winref Window Reference
55+
\ingroup guilib
56+
57+
The window reference
58+
*/
59+
60+
/*!
61+
\defgroup winmsg Windows and Messages
62+
\ingroup winref
63+
Windows and messages
64+
*/
65+
66+
/*!
67+
\defgroup controls Controls
68+
\ingroup winref
69+
Control classes
70+
*/
71+
72+
/*!
73+
\defgroup winman Window Manager and Callbacks
74+
\ingroup winref
75+
76+
Everything about window manager and callbacks
77+
*/
78+
79+
/*!
80+
\defgroup actionkeys Actions and Keys
81+
\ingroup winref
82+
83+
Everything around action mapping and key processing
84+
*/
85+
86+
/*!
87+
\defgroup graphics Graphics and Screen
88+
\ingroup guilib
89+
90+
Everything around graphics and Screen
91+
*/
92+
93+
/*!
94+
\defgroup textures Textures and Fonts
95+
\ingroup graphics
96+
97+
Everything about textures and fonts
98+
*/
99+
100+
/*!
101+
\defgroup strings Strings and Localization
102+
\ingroup guilib
103+
104+
Everything around Strings and localization
105+
*/
106+
107+
/*!
108+
\defgroup tinyxml XML Parser
109+
\ingroup strings
110+
111+
Tiny XML - XML Parser
112+
*/
113+
114+
/*!
115+
\defgroup jobs Asynchronous jobs
116+
117+
Threaded job execution
118+
*/

0 commit comments

Comments
 (0)