/usr/include/sofa/doc.h is in libsofa1-dev 1.0~beta4-6.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 | /******************************************************************************
* SOFA, Simulation Open-Framework Architecture, version 1.0 beta 4 *
* (c) 2006-2009 MGH, INRIA, USTL, UJF, CNRS *
* *
* This library is free software; you can redistribute it and/or modify it *
* under the terms of the GNU Lesser General Public License as published by *
* the Free Software Foundation; either version 2.1 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 Lesser General Public License *
* for more details. *
* *
* You should have received a copy of the GNU Lesser General Public License *
* along with this library; if not, write to the Free Software Foundation, *
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. *
*******************************************************************************
* SOFA :: Framework *
* *
* Authors: M. Adam, J. Allard, B. Andre, P-J. Bensoussan, S. Cotin, C. Duriez,*
* H. Delingette, F. Falipou, F. Faure, S. Fonteneau, L. Heigeas, C. Mendoza, *
* M. Nesme, P. Neumann, J-P. de la Plata Alcade, F. Poyer and F. Roy *
* *
* Contact information: contact@sofa-framework.org *
******************************************************************************/
#ifndef SOFA_DOC_H
// This file is only used to provide contents to the doxygen-generated documentation
// It should not be included by any external code
// * \version SVN trunk HEAD
/** \mainpage SOFA API Documentation
*
* \TODO TODO: Write main intro page...
*
* A good starting point to browse this documentation is the <a href="namespaces.html">Namespace List</a>.
*
*/
/** \namespace sofa
* \brief Main SOFA namespace
*/
/** \defgroup sofa_framework sofa-framework package
* \{
*/
/** \namespace sofa::helper
* \brief Utility helper classes that we need, but that are not the core of the plateform.
*/
/** \namespace sofa::helper::io
* \brief Image and Mesh I/O.
*/
/** \namespace sofa::helper::gl
* \brief GL drawing helper classes, no actual visual models.
*/
/** \namespace sofa::helper::system
* \brief OS-specific classes
*/
/** \namespace sofa::helper::system::thread
* \brief Portable multithreading helper classes (thread, mutex, ...).
*/
/** \namespace sofa::defaulttype
* \brief Default data types for the most common cases (1D/2D/3D vectors, rigid frames).
*
* Users can define other types, but it is best to try to use these when
* applicable, as many components are already instanciated with them.
* It is however not a requirement (nothing prevents a user to define his own
* Vec3 class for instance).
*
*/
/** \namespace sofa::core
* \brief Base standardized classes.
*
* Classes in the root sofa::core namespace define the 'high-level' sofa models.
*
*/
/** \namespace sofa::core::objectmodel
* \brief SOFA Object Model.
*
* Specifies how generic objects and context are handled, as well as the basic
* functionnalities of all objects (name, fields, ...).
*/
/** \namespace sofa::core::componentmodel
* \brief SOFA Component Model.
*
* A composent is defined as an object with a specific role in a Sofa
* simulation.
*
*/
/** \namespace sofa::core::componentmodel::behavior
* \brief Abstract API of components related to the behavior of simulated objects.
*
* Simulated bodies in SOFA are split into components storing the current
* state (MechanicalState), handling mass properties (Mass), computing
* forces (ForceField) and constraints (Constraint), and managing the
* integration algorithm (MasterSolver, OdeSolver).
*
* Depending on the solvers used, two modes of computations are used :
* \li <i>vector</i> mode : computations are done directly in the vectors
* stored in MechanicalState (used for explicit schemes or iterative
* solvers such as conjugate gradient).
* \li <i>matrix</i> mode : matrices corresponding to the mechanical system of
* equations are constructed, and then inversed to compute the new state.
* Not all components support the matrix mode of computation, as it is rather
* new and not yet finalized.
*
*/
/** \namespace sofa::core::componentmodel::collision
* \brief Abstract API of components related to collision handling.
*/
/** \namespace sofa::core::componentmodel::topology
* \brief Abstract API of components related to topologies.
*/
/** \} */
/** \defgroup sofa_modules sofa-modules package
* \{
*/
/** \namespace sofa::component
* \brief Implementation of components.
*/
/** \namespace sofa::simulation
* \brief Simulation data structure and scheduling (scene-graph, multithread support).
*/
/** \namespace sofa::simulation::tree
* \brief Default (and currently only) implementation of the simulation data structure using a tree.
*/
/** \namespace sofa::simulation::tree::xml
* \brief XML I/O classes.
*/
/** \} */
/** \defgroup sofa_applications sofa-applications package
* \{
*/
/** \namespace sofa::gui
* \brief User Interfaces
*/
/** \namespace sofa::gui::qt
* \brief Qt-based User Interface.
*/
/** \} */
#endif
|