Ruben Martinez-Cantin avatar Ruben Martinez-Cantin committed d749bf4

Extending documentation (demos)

Comments (0)

Files changed (1)

doxygen/demos.dox

 /*! \page demos Description of demo files
+\tableofcontents
+
+We have include a descriptions of the different demos than can be found in the
+library. Most of them are used to highlight the capabilities of the Bayesian optimization
+framework or the characteristics of the library.
+
+\b Important: note that some demos requires some extra dependencies to work (OpenGL, SimpleCV, etc.)
+
+\section cppdemos C/C++ demos
+
+These demos are automatically compiled and installed with the library.
+
+\b bo_cont and \b bo_disc provides examples of the C (callback) and C++ (inheritance) interfaces for a simple quadratic function. They are the best starting point to start playing with the library.
+
+\b bo_oned deals with a more interesting, yet simple, multimodal 1D function. \b bo_display shows the same example, but includes a visualization tool (requires OpenGL and FreeGLUT)
 
 */
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.