Commit ff891967 authored by saubatn's avatar saubatn
Browse files

UPDATED New structure API Documentation.

git-svn-id: svn+ssh://scm.forge.imag.fr/var/lib/gforge/chroot/scmrepos/svn/camitk/trunk/camitk@1261 ec899d31-69d1-42ba-9299-647d76f65fb3
parent 3e10195e
......@@ -27,9 +27,14 @@
#define CREATESC_H
#include <Action.h>
/** generate MML/Sofa scn from a vtk mesh
*/
/**
* @ingroup group_cepmodeling_actions_mml
*
* @brief
* Action to generate MML/Sofa scn from a vtk mesh.
*
*
**/
class CreateSC : public camitk::Action {
public:
......
......@@ -27,9 +27,14 @@
#define GENERATEMODEL_H
#include <Action.h>
/** generate MML/Sofa scn from a vtk mesh
*/
/**
* @ingroup group_cepmodeling_actions_mml
*
* @brief
* Action to generate MML/Sofa scn from a vtk mesh.
*
*
**/
class GenerateModel : public camitk::Action {
public:
......
......@@ -29,7 +29,14 @@
#include <QObject>
#include <Action.h>
#include <ActionExtension.h>
/**
* @ingroup group_cepmodeling_actions_mml
*
* @brief
* Manager for the MML action.
*
*
**/
class MMLActionExtension : public camitk::ActionExtension {
Q_OBJECT
Q_INTERFACES(camitk::ActionExtension)
......
......@@ -36,11 +36,14 @@ class MMLDisplay;
class MMLComponentPopup;
class MonitoringGuiManager;
class PMManagerDC;
/** This class manage an MML monitoring document ".mml".
*
*
*/
/**
* @ingroup group_cepmodeling_components_mml
*
* @brief
* This class manage an MML monitoring document ".mml".
*
*
**/
class MMLComponent : public camitk::Component {
Q_OBJECT
......
......@@ -28,11 +28,16 @@
#include <QObject>
#include <ComponentExtension.h>
/** This MML ComponentPlugin allows you to manipulate MML document.
/**
* @ingroup group_cepmodeling_components_mml
*
* @brief
* This MML ComponentPlugin allows you to manipulate MML document.
* see http://www-timc.imag.fr/Aurelien.Deram/ for more information on
* this type of documents.
*/
*
*
**/
class MMLComponentExtension : public camitk::ComponentExtension {
Q_OBJECT
Q_INTERFACES(camitk::ComponentExtension);
......
......@@ -27,13 +27,15 @@
#define MMLCOMPONENTPOPUP_H
#include <ComponentPopupMenu.h>
/**
/**
* @ingroup group_cepmodeling_components_mml
*
* @brief
* A popup monu for MML component
* Acessible when rigth cliking on the component
*/
*
*
**/
class MMLComponentPopup : public camitk::ComponentPopupMenu {
Q_OBJECT
......
......@@ -34,6 +34,14 @@ class MMLMonitorDisplay;
#include <monitor/Monitor.h>
/**
* @ingroup group_cepmodeling_components_mml
*
* @brief
* TODO Describe the class here
*
*
**/
class MMLDisplay: QObject {
Q_OBJECT
......
......@@ -32,6 +32,14 @@
class MMLComponent;
/**
* @ingroup group_cepmodeling_components_mml
*
* @brief
* TODO Describe the class here
*
*
**/
class MMLMonitorDisplay:public QObject{
......
......@@ -34,10 +34,14 @@
class MMLMonitorDisplay;
class MMLComponent;
/**
* A Factory for creating MMLMonitorDiplay
*/
* @ingroup group_cepmodeling_components_mml
*
* @brief
* A Factory for creating MMLMonitorDiplay
*
*
**/
class MMLMonitorDisplayFactory {
public:
......
......@@ -59,16 +59,18 @@ namespace std {
/** the iterator corresponding to the IndexInParentItemMap map */
typedef std::map <camitk::InterfaceNode *, unsigned int>::iterator IndexInParentItemMapIterator;
}
/**The manager of the Atom data.
/**
* @ingroup group_cepmodeling_components_physicalmodel
*
* @brief
* The manager of the Atom data.
* AtomDC are only created in the StructuralComponentDC constructor,
* which garanties that each atom has ONE AND ONLY ONE DC.
* But as Atom can be referenced by more than one Component (StructuralComponent or Cell)
* AtomDC is a particular type of DC that can have more than one parent DC (setParent is
* rewritten here).
*
*
*/
**/
class PHYSICALMODEL_COMPONENT_API AtomDC : public camitk::Component {
Q_OBJECT
public:
......
......@@ -27,12 +27,14 @@
#define AtomDCPOPUP_H
#include <ComponentPopupMenu.h>
/** The popup menu of the atom data component.
/**
* @ingroup group_cepmodeling_components_physicalmodel
*
* @brief
* The popup menu of the atom data component.
* Allows one to do different things directly from the DC popup.
*
*/
*
**/
class AtomDCPopup : public camitk::ComponentPopupMenu {
Q_OBJECT
......
......@@ -32,20 +32,18 @@
#include <QVector3D>
class AtomDC;
//***************************************************************************
/**
* @ingroup group_cepmodeling_components_physicalmodel
*
* @brief
* The class AtomDCProperties defines an object that allows interaction
* of some properties of an atom.
*
* The default atom properties are created thanks to Q_PROPERTY.
* The extra properties found in the PML document are also available thanks
* to the dynamic features of the Qt's Property System (see qt documentation).
*
*
*/
**/
class AtomDCProperties : public QObject {
Q_OBJECT
......
......@@ -38,8 +38,10 @@ class QListWidgetItem;
class AtomDC;
//***************************************************************************
/**
* @ingroup group_cepmodeling_components_physicalmodel
*
* @brief
* The class AtomDCWidget defines a widget controling the properties of
* an instance of an AtomDC.
*
......@@ -49,10 +51,9 @@ class AtomDC;
* is created and displayed. When the user selects another atom, the widget is updated
* with the property of the selected atom (via method updateProperties(...) ).
* see PMManagerDC for the control of the instance.
*
*
*/
*
**/
class AtomDCWidget : public QWidget {
Q_OBJECT
......
......@@ -35,13 +35,15 @@
class Cell;
class Atom;
class CellDCProperties;
//class StructuralComponent;
/**The manager of the Cell data.
* CellDC are only created in the StructuralComponentDC constructor, which garanties that each cell has ONE AND ONLY ONE DC.
/**
* @ingroup group_cepmodeling_components_physicalmodel
*
* @brief
* The manager of the Cell data.
* CellDC are only created in the StructuralComponentDC constructor, which garanties that each cell has ONE AND ONLY ONE DC.
*
*/
*
**/
class CellDC : public StructuralComponentDC {
Q_OBJECT
public:
......
......@@ -28,18 +28,19 @@
#include <QObject>
class CellDC;
/**
* @ingroup group_cepmodeling_components_physicalmodel
*
* @brief
* The class CellDCProperties defines an QObject that allows user interaction
* with properties of a cell (in an automatically generated UI)
*
* The default cell properties are created thanks to Q_PROPERTY.
* The extra properties found in the PML document are also available thanks
* to the dynamic features of the Qt's Property System (see qt documentation).
*
*
*/
*
**/
class CellDCProperties : public QObject {
Q_OBJECT
......
......@@ -32,12 +32,14 @@
class PMManagerDC;
#include "PMComponentAPI.h"
/**The manager of the Component data.
*
/**
* @ingroup group_cepmodeling_components_physicalmodel
*
*/
* @brief
* The manager of the Component data.
*
*
**/
class PHYSICALMODEL_COMPONENT_API ComponentDC : public camitk::MeshComponent {
Q_OBJECT
public:
......
......@@ -37,12 +37,16 @@ class QPixmap;
class QMenu;
class StructuralComponentDC;
/**The manager of the MultiComponent data.
* <b>NOTE:</b> a MultipleComponent has no concrete Geometry.
/**
* @ingroup group_cepmodeling_components_physicalmodel
*
*/
* @brief
* The manager of the MultiComponent data.
*
* @note
* MultipleComponent has no concrete Geometry.
*
**/
class PHYSICALMODEL_COMPONENT_API MultiComponentDC : public ComponentDC {
Q_OBJECT
public:
......
......@@ -28,11 +28,14 @@
#include <ComponentPopupMenu.h>
/** The popup menu of the multi component data component.
/**
* @ingroup group_cepmodeling_components_physicalmodel
*
* @brief
* The popup menu of the multi component data component.
* Allows one to do different things directly from the DC popup.
*
*/
*
**/
class MultiComponentDCPopup : public camitk::ComponentPopupMenu {
Q_OBJECT
......
......@@ -29,13 +29,15 @@
#include <QObject>
#include <MeshComponentExtension.h>
/** This PML ComponentExtension allows you to manipulate physical model file ".pml".
/**
* @ingroup group_cepmodeling_components_physicalmodel
*
* @brief
* This PML ComponentExtension allows you to manipulate physical model file ".pml".
* see http://www-timc.imag.fr/Emmanuel.Promayon/pml for more information on
* this type of documents.
*
* this type of documents.
*
*/
**/
class PMComponentExtension : public camitk::MeshComponentExtension {
Q_OBJECT
Q_INTERFACES(camitk::ComponentExtension)
......
......@@ -82,16 +82,18 @@ typedef std::map <Atom *, AtomDC *> AtomDCMap;
/** the iterator corresponding to the AtomDCMap map */
typedef std::map <Atom *, AtomDC *>::iterator AtomDCMapIterator;
}
/**The manager of the physical model data.
*
* NOTE: each cell has one and only one CellDC (see StructuralComponentDC constructor code).
*
* NOTE: each atom has one and only one AtomDC (see StructuralComponentDC constructor code).
/**
* @ingroup group_cepmodeling_components_physicalmodel
*
* @brief
* The manager of the physical model data.
*
* @note
* Each cell has one and only one CellDC (see StructuralComponentDC constructor code).
* Each atom has one and only one AtomDC (see StructuralComponentDC constructor code).
*
*/
*
**/
class PHYSICALMODEL_COMPONENT_API PMManagerDC : public camitk::MeshComponent {
Q_OBJECT
public:
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment