Skip to content
Browse files

added: Ticket #8438 - doxygen resources for generating sourcecode doc…

…umentation, thanks to chronodekar

git-svn-id: https://xbmc.svn.sourceforge.net/svnroot/xbmc/trunk@26557 568bbfeb-2a22-0410-94d2-cc84cf5bfa90
  • Loading branch information...
1 parent 3e4b7e5 commit ccea07a5a4229a0f7ebb7ff58e034820751a744a jmarshallnz committed
Showing with 1,585 additions and 0 deletions.
  1. +1,559 −0 doxygen_resources/Doxyfile.doxy
  2. +5 −0 doxygen_resources/README.TXT
  3. +21 −0 doxygen_resources/pages/mainpage.dox
View
1,559 doxygen_resources/Doxyfile.doxy
1,559 additions, 0 deletions not shown because the diff is too large. Please use a local Git client to view these changes.
View
5 doxygen_resources/README.TXT
@@ -0,0 +1,5 @@
+To generate doxygen documentation,
+
+run doxygen on the "Doxyfile.doxy" configuration file in this directory. It will generate HTML documenation
+in the ../docs folder (under "html")
+
View
21 doxygen_resources/pages/mainpage.dox
@@ -0,0 +1,21 @@
+/*! \file mainpage.dox
+ \brief Introduction page
+
+ \mainpage Introduction
+ Welcome to the documentation of XBMC. This starting page is meant to help people find their
+ way around the code.
+
+ This documentation is a work in progress - only some of the code has thus far been documented
+ 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.
+
+ \section doxy_whatisxbmc What is XBMC?
+ 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.
+*/

0 comments on commit ccea07a

Please sign in to comment.
Something went wrong with that request. Please try again.