Vous avez reçu un message "Your GitLab account has been locked ..." ? Pas d'inquiétude : lisez cet article https://docs.gricad-pages.univ-grenoble-alpes.fr/help/unlock/

Commit db97ada2 authored by promayon's avatar promayon
Browse files

FIXED some doxygen @see and other misuage of doxygen tags


git-svn-id: svn+ssh://scm.forge.imag.fr/var/lib/gforge/chroot/scmrepos/svn/camitk/trunk/camitk@502 ec899d31-69d1-42ba-9299-647d76f65fb3
parent 5ffb4b30
......@@ -113,10 +113,10 @@ private slots:
protected:
/// overwritten from QWidget to ensure fit in view @see fitView
/// overwritten from QWidget to ensure fit in view, see fitView()
virtual void resizeEvent(QResizeEvent *);
/// overwritten from QWidget to ensure fit in view @see fitView
/// overwritten from QWidget to ensure fit in view, see fitView()
virtual void showEvent(QShowEvent *);
private:
......
/*****************************************************************************
* $CAMITK_LICENCE_BEGIN$
*
* CamiTK - Computer Assisted Medical Intervention ToolKit
* (c) 2001-2013 UJF-Grenoble 1, CNRS, TIMC-IMAG UMR 5525 (GMCAO)
*
* Visit http://camitk.imag.fr for more information
*
* This file is part of CamiTK.
*
* CamiTK is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* CamiTK 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 version 3 for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with CamiTK. If not, see <http://www.gnu.org/licenses/>.
*
* $CAMITK_LICENCE_END$
/*****************************************************************************
* $CAMITK_LICENCE_BEGIN$
*
* CamiTK - Computer Assisted Medical Intervention ToolKit
* (c) 2001-2013 UJF-Grenoble 1, CNRS, TIMC-IMAG UMR 5525 (GMCAO)
*
* Visit http://camitk.imag.fr for more information
*
* This file is part of CamiTK.
*
* CamiTK is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* CamiTK 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 version 3 for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with CamiTK. If not, see <http://www.gnu.org/licenses/>.
*
* $CAMITK_LICENCE_END$
****************************************************************************/
#ifndef TESTCLASS_H_
#define TESTCLASS_H_
......@@ -69,7 +69,7 @@ class TestClass : public QObject
* Note that the only supported type of map is QVariantMap which is a typedef
* of QMap<QString, QVariant>.
* In this group all other misc type of supported properties are demonstrated.
* @see QVariant
* see QVariant
*/
Q_PROPERTY(QVariantMap propertyGroup READ getGroup WRITE setGroup)
......
......@@ -72,7 +72,7 @@ void ObjComponent::initDynamicProperties() {
// bool propValue = property("Show Glyph").toBool();
// you can also convert your value to QString. But beware that for some types of
// QVariant the conversion is not automatic (e.g. QColor to QString).
// @see the QVariant canConvert<T> and value<T> methods documentation
// see the QVariant canConvert<T> and value<T> methods documentation
CAMITK_INFO("ObjComponent", "initDynamicProperties", "Value of \"Show Glyph\": " << property("Show Glyph").toString().toStdString())
}
......
......@@ -45,7 +45,7 @@ class ObjComponent : public MeshComponent {
/// @{
/** These are read-only static properties.
* You need to have a Q_OBJECT line at the top of the class for static properties to be correctly handled.
* This component also has dynamic property, @see initDynamicProperties
* This component also has dynamic property, see initDynamicProperties()
*/
Q_PROPERTY(int nbPoints READ getNbPoints);
Q_PROPERTY(int nbCells READ getNbCells);
......
......@@ -124,7 +124,7 @@ public:
*/
void updatePosition();
/// reset the alreadyMoved flag to false @see alreadyMoved
/// reset the alreadyMoved flag to false, see alreadyMoved property
void resetAlreadyMovedFlag();
/// get the atom this dc is representing
......
......@@ -151,52 +151,6 @@ public:
/// destroy all the atom data
void destroyPointData();
/*
// /@name Input/Output
// /@see save (for vtk export)
// /@{
// / Transform an geometry to a physical model
static PhysicalModel * geometryToPhysicalModel(Geometry *);
/ ** Read the file given in parameter as a VTK file and create a physical model from it .
* As no assumpution could be made on a basic VTK file, the resulting physical model
* object will have only the list of atoms and one exclusive component containing all the vtk cells.
* As this method use the VtkMeshUtil static methods, it can import from any vtk file that
* are supported by the VtkMeshUtil class.
* Beware to remember to delete this physical model in your own method.
* @return the new physical model or NULL if an error occurs.
* /
static PhysicalModel * vtkToPhysicalModel(const QString&);
/ ** Create a StructuralComponent from a list of vtkPoints
* (i.e. the resulting structural component is simply a list of atoms).
* @param n name to give to the structural component
* /
static StructuralComponent *vtkToPhysicalModel(PhysicalModel *, vtkSmartPointer<vtkPoints>, const QString& n);
/ ** Create a Cell Structure from a vtkCell and the atom StructuralComponent describing the
* list where to find the atoms to use. This StructuralComponent has to be complete.
* This method is mostly used in conjonction with vtkToPhysicalModel(vtkPoints*, std:string) method
* (the latter giving the proper StructuralComponent to use here).
* /
static StructuralComponent *vtkToPhysicalModel(PhysicalModel *, vtkSmartPointer<vtkCell>, StructuralComponent *atomSC);
/ ** Export the structure to a vtk file.
* Write all the list of atoms as the vtkPoints and the exclusive cells as the vtkCells.
* @return tells if the method worked properly (or not!).
* /
static bool physicalModelToVtk(PhysicalModel *, const QString& fileName);
/ ** same as physicalModelToVtk but considering all the nodes.
* Directly write all the atoms and cell, even if some atoms are not used
* This is the method to call to export the PM for Ansys, and be able to use
* the informative components.
* /
static bool physicalModelToVtkAllNodes(PhysicalModel *myPM, const QString&);
// /@}
*/
/// @name Physical Model <-> Component
/// to get a Component corresponding to a PhysicalModel component or structure
///@{
......
......@@ -154,12 +154,12 @@ class ActionExtension;
* The method applyInPipeline() performs some pre- and post-processing around the method apply().
* It has to be used within a pipeline (a chain of actions) where setInputComponents()
* and getOutputComponents() are needed. preProcess() only selects the right components,
* and postProcess() sets output components and record history (TODO).
* and postProcess() sets output components and record history.
*
*
* For a simple example of an embedded action @see RenderingOption
* For a simple example of a non-embedded action @see RigidTransform
* For a simple example of an action with no widget (but with a GUI) @see ChangeColor
* @see RenderingOption For a simple example of an embedded action
* @see RigidTransform For a simple example of a non-embedded action
* @see ChangeColor For a simple example of an action with no widget (but with a GUI)
*/
class CAMITK_API Action : public QObject {
......
......@@ -52,7 +52,7 @@ class Action;
* - init: a simple enough method, just call registerNewAction(MyAction) for any
* MyAction class inheriting from camitk::Action
*
* For an example of an extension registering 3 new actions @see BasicMeshExtension
* @see BasicMeshExtension For an example of an extension registering more than one actions
*/
class CAMITK_API ActionExtension : public QObject {
......
......@@ -284,14 +284,16 @@ public:
///@name actions pipeline history
///@{
/// Add the history item to the application history
/// The item is added to the history stack of actions used in a pipeline
/// To pop back an action from the history use @see removeHistoryItem
/// @param item the item to add to the history
/** Add the history item to the application history.
* The item is added to the history stack of actions used in a pipeline
* @see removeLastHistoryItem() To pop back an action from the history use
* @param item the item to add to the history
*/
static void addHistoryItem(HistoryItem item);
/// Remove the last pushed actions in the history of the current pipeline
/// To push back the item use @see addHistoryItem
/** Remove the last pushed actions in the history of the current pipeline.
* @see addHistoryItem() To push back the item use
*/
static HistoryItem removeLastHistoryItem();
///@}
......
......@@ -63,8 +63,8 @@ public:
/// @name general
///@{
/** Constructor, the window title can be changed here, it is inconsistent to use setWindowTitle.
* If you like to dynamically add some information to the window title, please use setWindowSubtitle instead.
/** Constructor, the window title can be changed here, it is inconsistent to use setWindowTitle().
* If you like to dynamically add some information to the window title, please use setWindowSubtitle() instead.
*
* @see setWindowSubtitle
* @param title main window title
......
......@@ -47,9 +47,6 @@ class ObjectController;
* to add a settings for a given class, either add a tab widgets (e.g. for plugin tabs)
* or add a new ObjectController tab using editSettings(QObject*).
*
* @see uic_Settings.ui
*
*
*/
class CAMITK_API SettingsDialog : public QDialog {
Q_OBJECT
......
......@@ -410,7 +410,8 @@ public:
* from InterfaceProperty ).
* You can also have a separate class to manage your Component properties. In this case, just overide this
* method and return the corresponding instance.
* @see PropertyExplorer ObjectController
* @see PropertyExplorer
* @see ObjectController
*/
virtual QObject * getPropertyObject() {
return this;
......
......@@ -120,7 +120,8 @@ class InterfaceGeometry {
* // in the end call setDataConnection()
* \endcode
*
* @see setDataConnection(vtkAlgorithmOutput*), Geometry
* @see setDataConnection()
* @see Geometry
*/
virtual vtkSmartPointer<vtkAlgorithmOutput> getDataPort() const = 0;
......@@ -139,7 +140,8 @@ class InterfaceGeometry {
* To remove your custom pipeline, either call setDataConnection(NULL) or
* theAbstractGeometry->setDataConnection(theAbstractGeometry->getDataPort())
*
* @see getDataPort(), Geometry
* @see getDataPort()
* @see Geometry
*/
virtual void setDataConnection(vtkSmartPointer<vtkAlgorithmOutput>) = 0;
......@@ -178,7 +180,7 @@ class InterfaceGeometry {
*
* @param pointId the vtkPoint id that was selected by picking
* @param pickingIsSelecting indicates if the current picking session is selecting or unselecting
* @see InteractiveViewer::isPickingEffectSelecting()
* @see InteractiveViewer
*/
virtual void pointPicked(vtkIdType pointId, bool pickingIsSelecting) = 0;
......@@ -191,7 +193,7 @@ class InterfaceGeometry {
*
* @param cellId the vtkCell id that was selected by picking
* @param pickingIsSelecting indicates if the current picking session is selecting or unselecting
* @see InteractiveViewer::isPickingEffectSelecting()
* @see InteractiveViewer
*/
virtual void cellPicked(vtkIdType cellId, bool pickingIsSelecting) = 0;
///@}
......
......@@ -58,7 +58,8 @@ public:
* from InterfaceProperty aka QObject).
* You can also have a separate class to manage your Component properties. In this case, just overide this
* method and return the corresponding instance.
* @see PropertyExplorer ObjectController
* @see PropertyExplorer
* @see ObjectController
*/
virtual QObject * getPropertyObject() = 0;
......
......@@ -45,7 +45,7 @@ namespace camitk
/** Creates a top-level MeshComponent from a file.
* \note this is only to be used from a Component Extension open(...) or from an Action that creates data from a filter or transformation of a vtkPointSet.
*
* Please consider using @see MeshComponent(vtkSmartPointer<vtkPointSet> , const QString &)
* Please consider using MeshComponent(vtkSmartPointer<vtkPointSet> , const QString &)
*/
MeshComponent(const QString & file) throw(AbortException);
......
......@@ -113,7 +113,7 @@ protected:
* therefore picking action is "unselection", and all subsequently calls to pickPoint(..) or pickCell(..)
* will use pickingIsSelecting=false (2nd parameter of the method). If the first picked component was not
* selected, then the picking session is going to select any picked component.
* @see InterfaceGeometry::pickPoint,InterfaceGeometry::pickCell
* @see InterfaceGeometry::pickPoint() InterfaceGeometry::pickCell()
*
* <hr>
*
......
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