goglapex.blogg.se

Doxygen tutorial
Doxygen tutorial













doxygen tutorial

\ref tutorial-dummy-robot This tutorial explains how to start with dummy robot. The next step is to reference this new page called tutorial-dummy-robot in ViSP main page documentation modifying $VISP_WS/visp/doc/, either adding as bellow a new section (here called "Playing with robots"), either introducing the reference to this new page in an existing section: \subsection tuto_robot Playing with robots.To illustrate this section we will consider a new tutorial file in $VISP_WS/visp/doc/tutorial/robot/dummy/tutorial-dummy-robot.doc that may contain something like: /**\page tutorial-dummy-robot Tutorial: How to start with dummy robot The first step is to start to write the tutorial.This sections explains how to add a new Doxygen tutorial like this one, that may appear in ViSP main page documentation Here you should be able to generate Doxygen documentation and see vpDummyWrapper appearing in the class list and class index:.As given in Overview section we recall the content of this file: #include.Similarly, introduce a new source file implemented in $VISP_WS/visp/modules/robot/src/real-robot/dummy_sdk/vpDummyWrapper.cpp that contains vpDummyWrapper class definition.

doxygen tutorial doxygen tutorial

There is also the "\class" Doxygen directive that allows to expose vpDummyWrapper class in Doxygen documentation that is generated using make visp_doc. Where VISP_HAVE_DUMMY_SDK macro is used to ensure that the build doesn't fail when DummySDK package is not detected or not used. \class vpDummyWrapper Dummy wrapper example. As given in Overview section we recall the content of this file: #ifndef vpDummyWrapper_h.You are now ready to introduce a new header file implemented in $VISP_WS/visp/modules/robot/include/visp3/robot/vpDummyWrapper.h that contains vpDummyWrapper class declaration.















Doxygen tutorial