source: OGRE/trunk/ogrenew/Docs/src/apimainpage.txt @ 657

Revision 657, 1.7 KB checked in by mattausch, 18 years ago (diff)

added ogre dependencies and patched ogre sources

Line 
1/**
2  @mainpage API Reference Start Page
3 
4  @section intro Introduction
5 
6  @subsection s1 What is this?
7  This is the complete API reference for OGRE; contained within are the
8  specifications for each class and the methods on those classes which you can
9  refer to when writing code which uses OGRE.
10 
11  @subsection s2 It's so BIG!
12 
13  Yes, yes it is (and thank you for noticing). OGRE is a large and complex
14  system so the API documentation, whilst fully inclusive and the most
15  complete reference to OGRE that you'll find, is not the recommended way to
16  start learning. You will certainly want
17  to refer to this documentation once you have found your feet, and pretty soon
18  referring to it will become second nature. Until then, you should begin with
19  more discussive documentation such as:
20  @li <a href="http://www.ogre3d.org/docs/manual/">The Manual</a> You should
21    also have a local copy of this in your distribution; the OGRE manual is a
22        general introduction to the OGRE principles and core components, and a
23        reference to various important parts of the OGRE system, especially the
24        script syntax for materials, particle systems, and overlays.
25  @li <a href="http://www.ogre3d.org/wiki">The OGRE Wiki</a> A Wiki is a
26        collaborative web-based documentation system where people in the whole
27        OGRE community can contribute tips, tutorials and sample code, among other
28        things. This is a gold mine for new and experienced users alike.
29
30  We make an effort to document our classes fully so we hope you can find what
31  you need here. However, if you can't find it, or you're not sure where to
32  start looking, visit the main OGRE website and dip into the community areas
33  like the wiki and the forums to get some assistance.
34 
35*/
36
Note: See TracBrowser for help on using the repository browser.