Commit 28950df9 authored by Romain Pacanowski's avatar Romain Pacanowski Committed by Ludovic Courtès

Changed the official documentation and added the \ingroup fitter directive

parent 9dea92ed
......@@ -25,6 +25,7 @@
/*! \brief A vertical segment fitter for rational function using the library CGAL
* \ingroup plugins
* \ingroup fitters
*/
class rational_fitter_cgal : public fitter
{
......
......@@ -24,7 +24,8 @@
#include <core/vertical_segment.h>
/*! \brief A rational function optimizer following the DCA algorithm.
*
* \ingroup plugins
* \ingroup fitters
* \todo Implement Papamarkos fitter?
* \todo I should be able to test when load a BRDF text file to ensure the
* loaded object is correct.
......
......@@ -24,6 +24,8 @@
/*! \brief A least square fitter for rational function using the library Eigen
* \ingroup plugins
* \ingroup fitters
* \todo : WRITE MORE
*/
class rational_fitter_eigen : public fitter
{
......
......@@ -22,6 +22,11 @@
#include <core/rational_function.h>
#include <core/vertical_segment.h>
/*! \brief A least square fitter for rational function
* \ingroup plugins
* \ingroup fitters
* \todo : WRITE MORE
*/
class rational_fitter_leastsquare : public fitter
{
public: // methods
......
......@@ -26,6 +26,10 @@
//#define USE_MATLAB
#define DEBUG
/*! \brief A plugin to fit rational function using the Matlab Engine
* \ingroup plugins
* \ingroup fitters
*/
class rational_fitter_matlab : public fitter
{
public: // methods
......
......@@ -26,6 +26,7 @@
* for a fixed number of coefficient. This plugin can run in parallel with OpenMP and
* is using QuadProg++ quadratic solver.
* \ingroup plugins
* \ingroup fitters
*
* \details
* You can find QuadProg++ <a href="http://quadprog.sourceforge.net/">here</a>.
......
......@@ -14,7 +14,10 @@
/*! \brief A vertical segment fitter for rational function using the library QuadProg++
* You can find the library here: http://quadprog.sourceforge.net/
* and the [Parsec library](http://icl.cs.utk.edu/parsec/index.html)
* \ingroup plugins
* \ingroup fitters
* \todo: WRITE MORE.
*/
class rational_fitter_parsec_one : public fitter
{
......
......@@ -25,6 +25,8 @@
/*! \brief A vertical segment fitter for rational function using the library QuadProg++
* You can find the library here: http://quadprog.sourceforge.net/
* \ingroup plugins
* \ingroup fitters
* \todo : WRITE MORE DOCUMENTATION
*/
class rational_fitter_quadprog : public fitter
{
......
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