diff options
| -rw-r--r-- | doxygen_resources/Doxyfile.doxy | 68 | ||||
| -rw-r--r-- | doxygen_resources/pages/mainpage.dox | 103 | ||||
| -rw-r--r-- | xbmc/doxygen.hpp | 163 |
3 files changed, 158 insertions, 176 deletions
diff --git a/doxygen_resources/Doxyfile.doxy b/doxygen_resources/Doxyfile.doxy index fb5238bcd1..ca16dec9a3 100644 --- a/doxygen_resources/Doxyfile.doxy +++ b/doxygen_resources/Doxyfile.doxy @@ -1,4 +1,4 @@ -# Doxyfile 1.6.1 +# Doxyfile 1.6.3 # This file describes the settings to be used by the documentation system # doxygen (www.doxygen.org) for a project @@ -397,6 +397,12 @@ HIDE_SCOPE_NAMES = NO SHOW_INCLUDE_FILES = YES +# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen +# will list include files with double quotes in the documentation +# rather than with sharp brackets. + +FORCE_LOCAL_INCLUDES = NO + # If the INLINE_INFO tag is set to YES (the default) then a tag [inline] # is inserted in the documentation for inline members. @@ -584,7 +590,7 @@ WARN_LOGFILE = # directories like "/usr/src/myproject". Separate the files or directories # with spaces. -INPUT = ../xbmc/utils \ +INPUT = ../xbmc \ ../guilib \ . @@ -645,7 +651,8 @@ RECURSIVE = YES # excluded from the INPUT source files. This way you can easily exclude a # subdirectory from a directory tree whose root is specified with the INPUT tag. -EXCLUDE = ../guilib/tinyXML +EXCLUDE = ../guilib/tinyXML \ + ../xbmc/lib # The EXCLUDE_SYMLINKS tag can be used select whether or not files or # directories that are symbolic links (a Unix filesystem feature) are excluded @@ -659,7 +666,11 @@ EXCLUDE_SYMLINKS = NO # against the file with absolute path, so to exclude all test directories # for example use the pattern */test/* -EXCLUDE_PATTERNS = */.svn/* +EXCLUDE_PATTERNS = */.svn/* \ + */.svn \ + */lib*/* \ + */*Codec/* \ + doxygen.hpp # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names # (namespaces, classes, functions, etc.) that should be excluded from the @@ -840,6 +851,12 @@ HTML_FOOTER = HTML_STYLESHEET = +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML +# page will contain the date and time when the page was generated. Setting +# this to NO can help when comparing the output of multiple runs. + +HTML_TIMESTAMP = YES + # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, # files or namespaces will be aligned in HTML using tables. If set to # NO a bullet list will be used. @@ -941,7 +958,7 @@ QCH_FILE = # Qt Help Project output. For more information please see # http://doc.trolltech.com/qthelpproject.html#namespace -QHP_NAMESPACE = +QHP_NAMESPACE = org.doxygen.Project # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating # Qt Help Project output. For more information please see @@ -973,6 +990,23 @@ QHP_SECT_FILTER_ATTRS = QHG_LOCATION = +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files +# will be generated, which together with the HTML files, form an Eclipse help +# plugin. To install this plugin and make it available under the help contents +# menu in Eclipse, the contents of the directory containing the HTML and XML +# files needs to be copied into the plugins directory of eclipse. The name of +# the directory within the plugins directory should be the same as +# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before +# the help appears. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have +# this name. + +ECLIPSE_DOC_ID = org.doxygen.Project + # The DISABLE_INDEX tag can be used to turn on/off the condensed index at # top of each HTML page. The value NO (the default) enables the index and # the value YES disables it. @@ -1013,15 +1047,26 @@ TREEVIEW_WIDTH = 250 FORMULA_FONTSIZE = 10 -# When the SEARCHENGINE tag is enable doxygen will generate a search box +# When the SEARCHENGINE tag is enabled doxygen will generate a search box # for the HTML output. The underlying search engine uses javascript # and DHTML and should work on any modern browser. Note that when using -# HTML help (GENERATE_HTMLHELP) or Qt help (GENERATE_QHP) -# there is already a search function so this one should typically -# be disabled. +# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets +# (GENERATE_DOCSET) there is already a search function so this one should +# typically be disabled. For large projects the javascript based search engine +# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution. SEARCHENGINE = NO +# When the SERVER_BASED_SEARCH tag is enabled the search engine will be +# implemented using a PHP enabled web server instead of at the web client +# using Javascript. Doxygen will generate the search PHP script and index +# file to put on the web server. The advantage of the server +# based approach is that it scales better to large projects and allows +# full text search. The disadvances is that it is more difficult to setup +# and does not have live searching capabilities. + +SERVER_BASED_SEARCH = NO + #--------------------------------------------------------------------------- # configuration options related to the LaTeX output #--------------------------------------------------------------------------- @@ -1038,7 +1083,10 @@ GENERATE_LATEX = NO LATEX_OUTPUT = latex # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be -# invoked. If left blank `latex' will be used as the default command name. +# invoked. If left blank `latex' will be used as the default command name. +# Note that when enabling USE_PDFLATEX this option is only used for +# generating bitmaps for formulas in the HTML output, but not in the +# Makefile that is written to the output directory. LATEX_CMD_NAME = latex diff --git a/doxygen_resources/pages/mainpage.dox b/doxygen_resources/pages/mainpage.dox index 1259b4b1b3..064fe4d008 100644 --- a/doxygen_resources/pages/mainpage.dox +++ b/doxygen_resources/pages/mainpage.dox @@ -9,9 +9,6 @@ and we welcome any and all input to documenting it further. Documentation serves both to help newcomers get to grips with the source quickly, and to highlight possible deficiencies in the code or interfaces. - - Currently the doxygen configuration file is set to only document the "xbmc\utils" directory, - though the ultimate goal is to document the public interface of everything. Any help/suggestions are more than welcome. @@ -19,3 +16,103 @@ XBMC is a free, open source (GPL) multimedia player that runs on Linux, Mac OS X (10.4 and later), AppleTV and Windows. See http://xbmc.org for more details. */ + +// Groups definition + +/////////////////////////////////////// +// +// xbmc project +// +/////////////////////////////////////// + +/*! + \defgroup windows XBMC windows + + XBMC windows +*/ + +/*! + \defgroup music Music info + + Elements used in my music +*/ + + +////////////////////////////////////// +// +// guilib project +// +////////////////////////////////////// + +/*! + \defgroup guilib guilib classes + + guilib classes +*/ + +/*! + \defgroup winref Window Reference + \ingroup guilib + + The window reference +*/ + +/*! + \defgroup winmsg Windows and Messages + \ingroup winref + Windows and messages +*/ + +/*! + \defgroup controls Controls + \ingroup winref + Control classes +*/ + +/*! + \defgroup winman Window Manager and Callbacks + \ingroup winref + + Everything about window manager and callbacks +*/ + +/*! + \defgroup actionkeys Actions and Keys + \ingroup winref + + Everything around action mapping and key processing +*/ + +/*! + \defgroup graphics Graphics and Screen + \ingroup guilib + + Everything around graphics and Screen +*/ + +/*! + \defgroup textures Textures and Fonts + \ingroup graphics + + Everything about textures and fonts +*/ + +/*! + \defgroup strings Strings and Localization + \ingroup guilib + + Everything around Strings and localization +*/ + +/*! + \defgroup tinyxml XML Parser + \ingroup strings + + Tiny XML - XML Parser +*/ + +/*! + \defgroup jobs Asynchronous jobs + + Threaded job execution +*/
\ No newline at end of file diff --git a/xbmc/doxygen.hpp b/xbmc/doxygen.hpp deleted file mode 100644 index 3e95ba68ee..0000000000 --- a/xbmc/doxygen.hpp +++ /dev/null @@ -1,163 +0,0 @@ -// Mainpage layout -/*! - \mainpage Developer documentation for XBMC - \section intro Introduction - Introduction to the manual - - \section requirements Requirements - You'll need the following to build XBMC \n - - Visual Studio.NET 2003 - - XDK 5778 or higher - - XBMC sources offcourse \n - You can download the latest snapshot of XBMC here: \n - http://xbmc.sourceforge.net/xbmc.tar.gz or \n - use CVS to get the sources. Look here: http://sourceforge.net/cvs/?group_id=87054 \n - - Next - - Install Visual Studio.NET \n - When installing VS.NET. Make sure to install all C++ stuff - - Install XDK 5778 (or higher) \n - Make sure to do a full install of the XDK!!! Minimal or customized install wont work - - use winrar or a similar program to uncompress xbmc.tar.gz into a folder \n - - \section compile Compiling - -# Start Visual Studio.NET and open the xbmc.sln solution file - -# Next build the solution with Build->Build Solution (Ctrl+Shift+B) \n - NOTE: Dont worry about the following warnings which appear at the end of the build. \n - They are normal and can be ignored \n - Creating Xbox Image... \n - IMAGEBLD : warning IM1029: library XONLINE is unapproved\n - IMAGEBLD : warning IM1030: this image may not be accepted for certification \n - Copying files to the Xbox... \n - -# Then when all is build, its time to install XBMC on your xbox! \n - (You can also use the build.bat file to make a build of xbmc) \n - - \section install Installation - -# edit xboxmediacenter.xml and fill in all the details for your installation \n - After editting xboxmediacenter.xml you need to copy the following files & folder to your xbox \n - lets say you're installing XBMC on your xbox in the folder e:\\apps\\xbmc then: \n - -# create e:\\apps\\xbmc on your xbox \n - -# copy following files from pc->xbox \n - - PC XBOX \n - ------------------------------------------------------------------------------- \n - XboxMediaCenter.xml -> e:\\apps\\xbmc\\XboxMediaCenter.xml \n - keymap.xml -> e:\\apps\\xbmc\\keymap.xml \n - FileZilla Server.xml-> e:\\apps\\xbmc\\FileZilla Server.xml \n - release/default.xbe -> e:\\apps\\xbmc\\default.xbe \n - mplayer/ -> e:\\apps\\xbmc\\mplayer (copy all files & subdirs) \n - skin/ -> e:\\apps\\xbmc\\skin (copy all files & subdirs) \n - language/ -> e:\\apps\\xbmc\\language (copy all files & subdirs) \n - weather/ -> e:\\apps\\xbmc\\weather (copy all files & subdirs) \n - xbmc/keyboard/media -> e:\\apps\\xbmc\\media (copy all files & subdirs) \n - visualisations -> e:\\apps\\xbmc\\visualisations (copy all files & subdirs) \n - scripts/ -> e:\\apps\\xbmc\\scripts (these are just samples, only extract if you want to experiment with it) \n - python -> e:\\apps\\xbmc\\python (unpack the .rar file) \n - web -> e:\\apps\\xbmc\\web (unpack the .rar file) \n - - !!! please not that you unpack the .rar files in scripts/ python/ and web/ !!! \n - - \section links Links - Related links - XBMC - http://xbmc.org \n - XBMC Forum - http://forum.xbmc.org/index.php \n - */ - - -/////////////////////////////////////// -// -// xbmc project -// -/////////////////////////////////////// - -/*! - \defgroup windows XBMC windows - - XBMC windows -*/ - -/*! - \defgroup music Music info - - Elements used in my music -*/ - - -////////////////////////////////////// -// -// guilib project -// -////////////////////////////////////// - -/*! - \defgroup guilib guilib classes - - guilib classes -*/ - -/*! - \defgroup winref Window Reference - \ingroup guilib - - The window reference -*/ - -/*! - \defgroup winmsg Windows and Messages - \ingroup winref - Windows and messages -*/ - -/*! - \defgroup controls Controls - \ingroup winref - Control classes -*/ - -/*! - \defgroup winman Window Manager and Callbacks - \ingroup winref - - Everything about window manager and callbacks -*/ - -/*! - \defgroup actionkeys Actions and Keys - \ingroup winref - - Everything around action mapping and key processing -*/ - -/*! - \defgroup graphics Graphics and Screen - \ingroup guilib - - Everything around graphics and Screen -*/ - -/*! - \defgroup textures Textures and Fonts - \ingroup graphics - - Everything about textures and fonts -*/ - -/*! - \defgroup strings Strings and Localization - \ingroup guilib - - Everything around Strings and localization -*/ - -/*! - \defgroup tinyxml XML Parser - \ingroup strings - - Tiny XML - XML Parser -*/ - -/*! - \defgroup jobs Asynchronous jobs - - Threaded job execution -*/ |