Skip to content

Commit

Permalink
minor docs updates
Browse files Browse the repository at this point in the history
  • Loading branch information
jlblancoc committed Mar 19, 2022
1 parent bf1ebf5 commit 4434b20
Show file tree
Hide file tree
Showing 5 changed files with 11 additions and 4 deletions.
3 changes: 3 additions & 0 deletions doc/source/tutorial-lib-layout.rst
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,9 @@ The MRPT CMake scripts automatically recognize those files under the src
directory with the pattern ``*_unittest.cpp`` as files for unit testing.
MRPT uses the Google’s gtest library to perform these tests.

To see how to invoke the regular unit tests, or how to run them automatically
under ``gdb`` or ``valgrind``, see: :ref:`unit_testing`.

Note that the ``*_unittest.cpp`` files are not included in the "mrpt-<name>”
library, but a new target ``test-<name>`` is automatically created which is
invoked when doing ``make test`` or ``make test_legacy``.
Expand Down
3 changes: 2 additions & 1 deletion libs/gui/include/mrpt/gui/CDisplayWindow.h
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,8 @@ class CDisplayWindow : public mrpt::gui::CBaseGUIWindow
const std::string& windowCaption = std::string(),
unsigned int initWidth = 400, unsigned int initHeight = 400);

/** Class factory returning a smart pointer */
/** Class factory returning a smart pointer, equivalent to
* `std::make_shared<>(...)` */
static CDisplayWindow::Ptr Create(
const std::string& windowCaption, unsigned int initWidth = 400,
unsigned int initHeight = 400);
Expand Down
3 changes: 2 additions & 1 deletion libs/gui/include/mrpt/gui/CDisplayWindow3D.h
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,8 @@ class CDisplayWindow3D : public mrpt::gui::CBaseGUIWindow
unsigned int initialWindowWidth = 400,
unsigned int initialWindowHeight = 300);

/** Class factory returning a smart pointer */
/** Class factory returning a smart pointer, equivalent to
* `std::make_shared<>(...)` */
static CDisplayWindow3D::Ptr Create(
const std::string& windowCaption, unsigned int initialWindowWidth = 400,
unsigned int initialWindowHeight = 300);
Expand Down
3 changes: 2 additions & 1 deletion libs/gui/include/mrpt/gui/CDisplayWindowGUI.h
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,8 @@ class CDisplayWindowGUI : public nanogui::Screen

virtual ~CDisplayWindowGUI() override;

/** Class factory returning a smart pointer */
/** Class factory returning a smart pointer, equivalent to
* `std::make_shared<>(...)` */
template <typename... Args>
static Ptr Create(Args&&... args)
{
Expand Down
3 changes: 2 additions & 1 deletion libs/gui/include/mrpt/gui/CDisplayWindowPlots.h
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,8 @@ class CDisplayWindowPlots : public mrpt::gui::CBaseGUIWindow
const std::string& windowCaption = std::string(),
unsigned int initialWidth = 350, unsigned int initialHeight = 300);

/** Class factory returning a smart pointer */
/** Class factory returning a smart pointer, equivalent to
* `std::make_shared<>(...)` */
static CDisplayWindowPlots::Ptr Create(
const std::string& windowCaption, unsigned int initialWindowWidth = 400,
unsigned int initialWindowHeight = 300);
Expand Down

0 comments on commit 4434b20

Please sign in to comment.