ROOT  6.06/09
Reference Guide
documentation/doxygen/mainpage.md
Go to the documentation of this file.
1 \mainpage %ROOT Reference Documentation
2 
3 ### Introduction
4 Welcome to %ROOT
5 
6 This documentation describes the software classes and functions that makes up the %ROOT softare system as well as their application programming interface (API).
7 This is not an introduction of %ROOT, for this please refer to the [%ROOT User Guides and Manuals](http://root.cern.ch/root-user-guides-and-manuals).
8 This documentation is generated directly from the source code using [Doxygen](http://doxygen.org) and in principle is kept up to date.
9 The version of %ROOT corresponding to this documentation is indicated at the page heading.
10 You may also find in [reference documentation page](http://root.cern.ch/guides/reference-guide) pointers to reference manuals for other %ROOT versions.
11 
12 ### How to use this reference documentation
13 The [User’s Classes](modules.html) in the top bar provides the user API, mainly the list of main Users' classes organized by module or functionality.
14 The full list of classes, both for the public API and for the implementation details are available under the [All Classes](annotated.html) tab.
15 A classification of classes based on their C++ namespace can be found under the [Namespace](namespaces.html) tab.
16 The fully indexed list of all source code is available under the tab [Files](files.html).
17 
18 ### %ROOT provides other types of documentation:
19 
20 - A general [Users Guide](http://root.cern.ch/root-user-guides-and-manuals) is provided for a more in depth explanation of concepts and functionality available in the %ROOT system.
21 - A number of topical [User Guides and Manuals](http://root.cern.ch/node/root-user-guides-and-manuals) for various components of the system.
22 - A rich set of %ROOT [tutorials and code examples](http://root.cern.ch/node/2836) are offered to developers to exercise specific functionality.
23 - A rich set of [HowTo's](http://root.cern.ch/node/2836) is also present to discuss issues commonly faced by %ROOT users.
24 
25 ### Caveat
26 We have moved recently to generate the documentation with Doxygen.
27 To achieve this the comments in the source code needed to be formatted and written specifically for Doxygen to generated proper documentation.
28 If you find missing documentation or inaccuracies please report them to our [bug tracker](https://sft.its.cern.ch/jira/secure/CreateIssue.jspa?pid=10010&issuetype=1). Detailed instructions on how to submit a bug can be found [here](http://root.cern.ch/how/report-bug-jira).
29