87 lines
4.3 KiB
Plaintext
87 lines
4.3 KiB
Plaintext
/***************************************************************************
|
|
* Copyright (c) Jürgen Riegel (juergen.riegel@web.de) 2002 *
|
|
* *
|
|
* This file is part of the FreeCAD CAx development system. *
|
|
* *
|
|
* This library is free software; you can redistribute it and/or *
|
|
* modify it under the terms of the GNU Library General Public *
|
|
* License as published by the Free Software Foundation; either *
|
|
* version 2 of the License, or (at your option) any later version. *
|
|
* *
|
|
* This library is distributed in the hope that it will be useful, *
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of *
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
|
|
* GNU Library General Public License for more details. *
|
|
* *
|
|
* You should have received a copy of the GNU Library General Public *
|
|
* License along with this library; see the file COPYING.LIB. If not, *
|
|
* write to the Free Software Foundation, Inc., 59 Temple Place, *
|
|
* Suite 330, Boston, MA 02111-1307, USA *
|
|
* *
|
|
***************************************************************************/
|
|
|
|
/**
|
|
|
|
\if WEB_DOCUMENTATION
|
|
|
|
\mainpage FreeCAD source documentation
|
|
|
|
This is the source documentation of <a href=http://www.freecadweb.org>FreeCAD</a>.
|
|
It is automatically generated from the source code, and describes the different
|
|
components of the FreeCAD source code, for both the parts written in C++ and Python.
|
|
|
|
For general help and documentation about the FreeCAD application and how to use it, head
|
|
first to the <a href=http//www.freecadweb.org/wiki>Wiki Documentation</a>.
|
|
|
|
Refer to the
|
|
<a href=http://www.freecadweb.org/wiki/The_FreeCAD_source_code>general
|
|
introduction to the FreeCAD source code</a> page for a broad view of how the source
|
|
code is organized, and browse the modules, classes and namespaces from the menu above.
|
|
|
|
The <a href=http://www.freecadweb.org/wiki/Developer_hub>Developers section</a>
|
|
of the wiki also contains additional information for developers, and the
|
|
<a href=http://www.freecadweb.org/wiki/Power_users_hub>Powerusers / python scripting
|
|
section</a> contains coding documentation that is specifically aimed at python scripting, but
|
|
that will also be useful to C++ coders, as most of the APIs are identical or very similar.
|
|
|
|
For space reasons, this on-line version doesn't include the source code headers nor the full
|
|
inheritance graphics. But you can build a full version yourself with everything included,
|
|
as explained in <a href=http://freecadweb.org/wiki/Source_documentation>building
|
|
the source code documentation</a>. You can also browse through the <a href=https://github.com/FreeCAD/FreeCAD>source
|
|
code on github</a>.
|
|
|
|
\endif
|
|
|
|
\if DEV_DOCUMENTATION
|
|
|
|
\mainpage FreeCAD source documentation
|
|
|
|
\image html freecadsplash.png
|
|
|
|
<b>Welcome to FreeCAD source documentation!</b>
|
|
|
|
We hope you'll find it a convenient tool to explore, understand and
|
|
experiment with the internals of the program.
|
|
|
|
Being generated from the actual state of the code, this documentation
|
|
is by no means a well structured corpus or a textbook, but more an
|
|
utility to browse through the sources.
|
|
|
|
If you seek informations on FreeCAD at large, please consult our
|
|
<a href="http://www.freecadweb.org/wiki/Main_Page">Wiki</a>
|
|
|
|
FreeCAD being a fast moving target, don't hesitate to rebuild an up to
|
|
date doc from source as often as needed (\ref makingdocs "more info"). CPU cycles are cheap
|
|
nowadays!
|
|
|
|
The homepage of FreeCAD is <a href="http://www.freecadweb.org">here</a>.
|
|
|
|
\endif
|
|
|
|
*/
|
|
|
|
/** \namespace std
|
|
\brief The Standard namespace for the C++ library
|
|
*/
|
|
|