FreeCAD

1
/***************************************************************************
2
 *   Copyright (c) 2002 Juergen Riegel <juergen.riegel@web.de>             *
3
 *                                                                         *
4
 *   This file is part of the FreeCAD CAx development system.              *
5
 *                                                                         *
6
 *   This library is free software; you can redistribute it and/or         *
7
 *   modify it under the terms of the GNU Library General Public           *
8
 *   License as published by the Free Software Foundation; either          *
9
 *   version 2 of the License, or (at your option) any later version.      *
10
 *                                                                         *
11
 *   This library  is distributed in the hope that it will be useful,      *
12
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
13
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
14
 *   GNU Library General Public License for more details.                  *
15
 *                                                                         *
16
 *   You should have received a copy of the GNU Library General Public     *
17
 *   License along with this library; see the file COPYING.LIB. If not,    *
18
 *   write to the Free Software Foundation, Inc., 59 Temple Place,         *
19
 *   Suite 330, Boston, MA  02111-1307, USA                                *
20
 *                                                                         *
21
 ***************************************************************************/
22

23
/**
24

25
    \mainpage FreeCAD source documentation
26

27
    This is the source documentation of <a href=https://www.freecad.org>FreeCAD</a>. 
28
    It is automatically generated from the source code, and describes the different 
29
    components of the FreeCAD source code, for both the parts written in C++ and Python. 
30
    
31
    For general help and documentation about the FreeCAD application and how to use it, head
32
    first to the <a href=https://www.freecad.org/wiki>Wiki Documentation</a>.
33
    
34
    Refer to the
35
    <a href=https://www.freecad.org/wiki/The_FreeCAD_source_code>general 
36
    introduction to the FreeCAD source code</a> page for a broad view of how the source
37
    code is organized, and browse the modules, classes and namespaces from the menu above.
38
    
39
    The <a href=https://www.freecad.org/wiki/Developer_hub>Developers section</a>
40
    of the wiki also contains additional information for developers, and the 
41
    <a href=https://www.freecad.org/wiki/Power_users_hub>Powerusers / python scripting
42
    section</a> contains coding documentation that is specifically aimed at python scripting, but
43
    that will also be useful to C++ coders, as most of the APIs are identical or very similar.
44
    
45
    For space reasons, this on-line version doesn't include the source code headers nor the full
46
    inheritance graphics. But you can build a full version yourself with everything included, 
47
    as explained in <a href=https://freecad.org/wiki/Source_documentation>building
48
    the source code documentation</a>. You can also browse through the <a href=https://github.com/FreeCAD/FreeCAD>source
49
    code on github</a>.
50

51
  \if DEV_DOCUMENTATION
52

53
  \mainpage FreeCAD source documentation
54

55
    \image html freecadsplash.png
56
    
57
    <b>Welcome to FreeCAD source documentation!</b>
58
    
59
    We hope you'll find it a convenient tool to explore, understand and
60
    experiment with the internals of the program.
61
    
62
    Being generated from the actual state of the code, this documentation
63
    is by no means a well structured corpus or a textbook, but more an
64
    utility to browse through the sources.
65
    
66
    If you seek information on FreeCAD at large, please consult our
67
    <a href="https://www.freecad.org/wiki/Main_Page">Wiki</a>
68
    
69
    FreeCAD being a fast moving target, don't hesitate to rebuild an up to
70
    date doc from source as often as needed (\ref makingdocs "more info"). CPU cycles are cheap
71
    nowadays! 
72
    
73
    The homepage of FreeCAD is <a href="https://www.freecad.org">here</a>.
74
  
75
  \endif
76

77
<small>
78
@GIT_REVISION_INFO@
79
</small>
80
 */
81

82
/** \namespace std
83
    \brief The Standard namespace for the C++ library
84
*/
85

86