Commit d5461226 authored by Jan Möbius's avatar Jan Möbius
Browse files

Fixed a lot of documentation bugs

git-svn-id: http://www.openflipper.org/svnrepo/OpenFlipper/branches/Free@14207 383ad7c9-94d9-4d36-a494-682f7c89f535
parent 9097a5c9
...@@ -11,13 +11,13 @@ ...@@ -11,13 +11,13 @@
* *
* Starting OpenFlipper invokes the following processes: <br><br> * Starting OpenFlipper invokes the following processes: <br><br>
* \subsection ref1 References: * \subsection ref1 References:
* \ref BaseInterface::initializePlugin(),<br>\ref BaseInterface::pluginsInitialized(),<br>\ref INIInterface::loadIniFileOptions()<br> * \ref BaseInterface::initializePlugin(),<br>BaseInterface::pluginsInitialized(),<br>INIInterface::loadIniFileOptions()<br>
* *
* \image html OpenFlipperStartup.png * \image html OpenFlipperStartup.png
* *
* \section loadSettings Load settings * \section loadSettings Load settings
* *
* Also see \ref INIInterface * Also see INIInterface
* *
* \subsection ref2 References: * \subsection ref2 References:
* \ref INIInterface::loadIniFileOptions(),<br>\ref INIInterface::loadIniFile(),<br>\ref INIInterface::loadIniFileOptionsLast()<br> * \ref INIInterface::loadIniFileOptions(),<br>\ref INIInterface::loadIniFile(),<br>\ref INIInterface::loadIniFileOptionsLast()<br>
...@@ -27,7 +27,7 @@ ...@@ -27,7 +27,7 @@
* *
* \section saveSettings Save settings * \section saveSettings Save settings
* *
* Also see \ref INIInterface * Also see INIInterface
* *
* \subsection ref3 References: * \subsection ref3 References:
* \ref INIInterface::saveIniFileOptions(),<br>\ref INIInterface::saveIniFile(),<br> * \ref INIInterface::saveIniFileOptions(),<br>\ref INIInterface::saveIniFile(),<br>
...@@ -40,10 +40,10 @@ ...@@ -40,10 +40,10 @@
* signal BaseInterface::updatedObject() in order to initiate the core to inform * signal BaseInterface::updatedObject() in order to initiate the core to inform
* all other plugins about the changes and redraw the scene. * all other plugins about the changes and redraw the scene.
* *
* Also see \ref BaseInterface * Also see BaseInterface
* *
* \subsection ref4 References: * \subsection ref4 References:
* \ref BaseInterface::updatedObject(),<br>\ref BaseInterface::slotObjectUpdated(),<br> * \ref BaseInterface::updatedObject(),<br>BaseInterface::slotObjectUpdated(),<br>
* \image html ObjectUpdateNotification.png * \image html ObjectUpdateNotification.png
* *
* *
......
...@@ -155,7 +155,7 @@ ...@@ -155,7 +155,7 @@
* \skipline } else if ( o_it->dataType( DATA_POLY_MESH ) ) { * \skipline } else if ( o_it->dataType( DATA_POLY_MESH ) ) {
* *
* The next step is to tell the OpenFlipper core that our plugin has updated an object in the scene. * The next step is to tell the OpenFlipper core that our plugin has updated an object in the scene.
* The affected object will then be redrawn. See \ref geometryData for information on how to handle geometry data in a plugin. * The affected object will then be redrawn.
* *
* \dontinclude example/SmootherPlugin.cc * \dontinclude example/SmootherPlugin.cc
* \skipline emit updatedObject( o_it->id() ); * \skipline emit updatedObject( o_it->id() );
......
...@@ -5,23 +5,22 @@ ...@@ -5,23 +5,22 @@
* Mouse interaction (especially object picking) and keyboard shortcuts * Mouse interaction (especially object picking) and keyboard shortcuts
* form essential and often used functionality in OpenFlipper. In this * form essential and often used functionality in OpenFlipper. In this
* tutorial we will learn how to use picking modes, context menus and * tutorial we will learn how to use picking modes, context menus and
* simple keyboard shortcuts. In addition we will focus a little bit on * simple keyboard shortcuts. The plugin will provide the following functions:
* what is explained in \ref geometryData. The plugin will provide the following functions:
* *
* - Hide object by right-clicking at it and selecting our defined action * - Hide object by right-clicking at it and selecting our defined action
* - Select an object by entering user defined pick mode and double-clicking * - Select an object by entering user defined pick mode and double-clicking
* at object in the scene * at object in the scene
* - Rotate selected object by hitting the w,s,a,d keys on the keyboard * - Rotate selected object by hitting the w,s,a,d keys on the keyboard
* *
* For this purpose we will make use of the following \ref interfaces: * For this purpose we will make use of the following \ref interfaces
* *
* - \ref BaseInterface * - \ref baseInterfacePage
* - \ref MouseInterface * - \ref mouseInterfacePage
* - \ref PickingInterface * - \ref pickingInterfacePage
* - \ref KeyInterface * - \ref keyInterfacePage
* - \ref ContextMenuInterface * - \ref contextMenuInterfacePage
* - \ref ToolboxInterface * - \ref toolboxInterfacePage
* - \ref LoggingInterface * - \ref loggingInterfacePage
* *
* Since we outlined the details of overriding the BaseInterface methods * Since we outlined the details of overriding the BaseInterface methods
* in the previous tutorials (\ref ex1 and \ref ex2) we can directly switch * in the previous tutorials (\ref ex1 and \ref ex2) we can directly switch
...@@ -92,7 +91,7 @@ ...@@ -92,7 +91,7 @@
* object's transform node (manipulatorNode) to hold a matrix that describes * object's transform node (manipulatorNode) to hold a matrix that describes
* a rotation around the x (if w or s is pressed) or y axis (if a or d is pressed) by +/- 10 degrees. * a rotation around the x (if w or s is pressed) or y axis (if a or d is pressed) by +/- 10 degrees.
* We then call the method transformMesh and pass the recently calculated matrix and * We then call the method transformMesh and pass the recently calculated matrix and
* a handle to the mesh (triangle or polygon). As said in \ref geometryData we have to * a handle to the mesh (triangle or polygon). We have to
* inform OpenFlipper's core about the changes by calling BaseInterface::updatedObject(int). * inform OpenFlipper's core about the changes by calling BaseInterface::updatedObject(int).
* *
* \dontinclude MouseAndKeyPlugin.cc * \dontinclude MouseAndKeyPlugin.cc
...@@ -118,11 +117,11 @@ ...@@ -118,11 +117,11 @@
* *
* \section ex3_source The complete source code of this example * \section ex3_source The complete source code of this example
* *
* We use the same project file as created in \ref ex1b. * We use the same project file as before.
* *
* MouseAndKeyPlugin.hh * MouseAndKeyPlugin.hh
* \include MouseAndKeyPlugin.hh * \include MouseAndKeyPlugin.hh
* *
* MouseAndKeyPlugin.cc * MouseAndKeyPlugin.cc
* \include MouseAndKeyPlugin.cc * \include MouseAndKeyPlugin.cc
*/ */
\ No newline at end of file
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