Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improved doxygen #996

Merged
merged 2 commits into from
Aug 26, 2021
Merged

Improved doxygen #996

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
11787a7
Improved doxygen
ahcorde Aug 25, 2021
78e009b
Improved docs
ahcorde Aug 26, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -178,6 +178,7 @@ if (NOT APPLE)
API_MAINPAGE_MD "${CMAKE_BINARY_DIR}/api.md"
TUTORIALS_MAINPAGE_MD "${CMAKE_BINARY_DIR}/tutorials.md"
ADDITIONAL_INPUT_DIRS "${CMAKE_SOURCE_DIR}/src/systems ${CMAKE_SOURCE_DIR}/src/gui/plugins"
IMAGE_PATH_DIRS "${CMAKE_SOURCE_DIR}/tutorials/files"
TAGFILES
"${IGNITION-MATH_DOXYGEN_TAGFILE} = ${IGNITION-MATH_API_URL}"
"${IGNITION-MSGS_DOXYGEN_TAGFILE} = ${IGNITION-MSGS_API_URL}"
Expand Down
96 changes: 64 additions & 32 deletions include/ignition/gazebo/Conversions.hh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,8 +88,9 @@ namespace ignition
/// \return Conversion result.
/// \tparam Out Output type.
template<class Out>
Out convert(const sdf::Geometry &/*_in*/)
Out convert(const sdf::Geometry &_in)
{
(void)_in;
Out::ConversionNotImplemented;
}

Expand All @@ -105,8 +106,9 @@ namespace ignition
/// \return Conversion result.
/// \tparam Out Output type.
template<class Out>
Out convert(const msgs::Pose &/*_in*/)
Out convert(const msgs::Pose &_in)
{
(void)_in;
Out::ConversionNotImplemented;
}

Expand All @@ -121,8 +123,9 @@ namespace ignition
/// \return Conversion result.
/// \tparam Out Output type.
template<class Out>
Out convert(const msgs::Geometry &/*_in*/)
Out convert(const msgs::Geometry &_in)
{
(void)_in;
Out::ConversionNotImplemented;
}

Expand All @@ -138,8 +141,9 @@ namespace ignition
/// \return Conversion result.
/// \tparam Out Output type.
template<class Out>
Out convert(const sdf::Material &/*_in*/)
Out convert(const sdf::Material &_in)
{
(void)_in;
Out::ConversionNotImplemented;
}

Expand All @@ -155,8 +159,9 @@ namespace ignition
/// \return Conversion result.
/// \tparam Out Output type.
template<class Out>
Out convert(const msgs::Material &/*_in*/)
Out convert(const msgs::Material &_in)
{
(void)_in;
Out::ConversionNotImplemented;
}

Expand All @@ -172,8 +177,9 @@ namespace ignition
/// \return Conversion result.
/// \tparam Out Output type.
template<class Out>
Out convert(const sdf::Actor &/*_in*/)
Out convert(const sdf::Actor &_in)
{
(void)_in;
Out::ConversionNotImplemented;
}

Expand All @@ -189,8 +195,9 @@ namespace ignition
/// \return Conversion result.
/// \tparam Out Output type.
template<class Out>
Out convert(const msgs::Actor& /*_in*/)
Out convert(const msgs::Actor& _in)
{
(void)_in;
Out::ConversionNotImplemented;
}

Expand All @@ -206,8 +213,9 @@ namespace ignition
/// \return Conversion result.
/// \tparam Out Output type.
template<class Out>
Out convert(const sdf::Light &/*_in*/)
Out convert(const sdf::Light &_in)
{
(void)_in;
Out::ConversionNotImplemented;
}

Expand All @@ -224,8 +232,9 @@ namespace ignition
/// \return Conversion result.
/// \tparam Out Output type.
template<class Out>
Out convert(const msgs::Light& /*_in*/)
Out convert(const msgs::Light& _in)
{
(void)_in;
Out::ConversionNotImplemented;
}

Expand All @@ -241,8 +250,9 @@ namespace ignition
/// \return Conversion result.
/// \tparam Out Output type.
template<class Out>
Out convert(const sdf::Gui &/*_in*/)
Out convert(const sdf::Gui &_in)
{
(void)_in;
Out::ConversionNotImplemented;
}

Expand All @@ -257,8 +267,9 @@ namespace ignition
/// \return Conversion result.
/// \tparam Out Output type.
template<class Out>
Out convert(const std::chrono::steady_clock::duration &/*_in*/)
Out convert(const std::chrono::steady_clock::duration &_in)
{
(void)_in;
Out::ConversionNotImplemented;
}

Expand All @@ -274,8 +285,9 @@ namespace ignition
/// \return Conversion result.
/// \tparam Out Output type.
template<class Out>
Out convert(const msgs::Time &/*_in*/)
Out convert(const msgs::Time &_in)
{
(void)_in;
Out::ConversionNotImplemented;
}

Expand All @@ -291,8 +303,9 @@ namespace ignition
/// \return Conversion result.
/// \tparam Out Output type.
template<class Out>
Out convert(const math::Inertiald &/*_in*/)
Out convert(const math::Inertiald &_in)
{
(void)_in;
Out::ConversionNotImplemented;
}

Expand All @@ -308,8 +321,9 @@ namespace ignition
/// \return Conversion result.
/// \tparam Out Output type.
template<class Out>
Out convert(const msgs::Inertial &/*_in*/)
Out convert(const msgs::Inertial &_in)
{
(void)_in;
Out::ConversionNotImplemented;
}

Expand All @@ -325,8 +339,9 @@ namespace ignition
/// \return Conversion result.
/// \tparam Out Output type.
template<class Out>
Out convert(const sdf::JointAxis &/*_in*/)
Out convert(const sdf::JointAxis &_in)
{
(void)_in;
Out::ConversionNotImplemented;
}

Expand All @@ -342,8 +357,9 @@ namespace ignition
/// \return Conversion result.
/// \tparam Out Output type.
template<class Out>
Out convert(const msgs::Axis &/*_in*/)
Out convert(const msgs::Axis &_in)
{
(void)_in;
Out::ConversionNotImplemented;
}

Expand All @@ -359,8 +375,9 @@ namespace ignition
/// \return Conversion result.
/// \tparam Out Output type.
template<class Out>
Out convert(const sdf::Scene &/*_in*/)
Out convert(const sdf::Scene &_in)
{
(void)_in;
Out::ConversionNotImplemented;
}

Expand All @@ -375,8 +392,9 @@ namespace ignition
/// \return Conversion result.
/// \tparam Out Output type.
template<class Out>
Out convert(const msgs::Scene &/*_in*/)
Out convert(const msgs::Scene &_in)
{
(void)_in;
Out::ConversionNotImplemented;
}

Expand All @@ -392,8 +410,9 @@ namespace ignition
/// \return Conversion result.
/// \tparam Out Output type.
template<class Out>
Out convert(const sdf::Atmosphere &/*_in*/)
Out convert(const sdf::Atmosphere &_in)
{
(void)_in;
Out::ConversionNotImplemented;
}

Expand All @@ -409,8 +428,9 @@ namespace ignition
/// \return Conversion result.
/// \tparam Out Output type.
template<class Out>
Out convert(const msgs::Atmosphere &/*_in*/)
Out convert(const msgs::Atmosphere &_in)
{
(void)_in;
Out::ConversionNotImplemented;
}

Expand All @@ -427,8 +447,9 @@ namespace ignition
/// \return Conversion result.
/// \tparam Out Output type.
template<class Out>
Out convert(const sdf::Physics &/*_in*/)
Out convert(const sdf::Physics &_in)
{
(void)_in;
Out::ConversionNotImplemented;
}

Expand All @@ -444,8 +465,9 @@ namespace ignition
/// \return Conversion result.
/// \tparam Out Output type.
template<class Out>
Out convert(const msgs::Physics &/*_in*/)
Out convert(const msgs::Physics &_in)
{
(void)_in;
Out::ConversionNotImplemented;
}

Expand All @@ -462,8 +484,9 @@ namespace ignition
/// \return Conversion result.
/// \tparam Out Output type.
template<class Out>
Out convert(const sdf::Sensor &/*_in*/)
Out convert(const sdf::Sensor &_in)
{
(void)_in;
Out::ConversionNotImplemented;
}

Expand All @@ -479,8 +502,9 @@ namespace ignition
/// \return Conversion result.
/// \tparam Out Output type.
template<class Out>
Out convert(const msgs::Sensor &/*_in*/)
Out convert(const msgs::Sensor &_in)
{
(void)_in;
Out::ConversionNotImplemented;
}

Expand All @@ -496,8 +520,9 @@ namespace ignition
/// \return Conversion result.
/// \tparam Out Output type.
template<class Out>
Out convert(const msgs::SensorNoise &/*_in*/)
Out convert(const msgs::SensorNoise &_in)
{
(void)_in;
Out::ConversionNotImplemented;
}

Expand All @@ -514,8 +539,9 @@ namespace ignition
/// \return Conversion result.
/// \tparam Out Output type.
template<class Out>
Out convert(const msgs::WorldStatistics &/*_in*/)
Out convert(const msgs::WorldStatistics &_in)
{
(void)_in;
Out::ConversionNotImplemented;
}

Expand All @@ -531,8 +557,9 @@ namespace ignition
/// \return Conversion result.
/// \tparam Out Output type.
template<class Out>
Out convert(const UpdateInfo &/*_in*/)
Out convert(const UpdateInfo &_in)
{
(void)_in;
Out::ConversionNotImplemented;
}

Expand All @@ -548,8 +575,9 @@ namespace ignition
/// \return Conversion result.
/// \tparam Out Output type.
template<class Out>
Out convert(const sdf::Collision &/*_in*/)
Out convert(const sdf::Collision &_in)
{
(void)_in;
Out::ConversionNotImplemented;
}

Expand All @@ -565,8 +593,9 @@ namespace ignition
/// \return Conversion result.
/// \tparam Out Output type.
template<class Out>
Out convert(const msgs::Collision &/*_in*/)
Out convert(const msgs::Collision &_in)
{
(void)_in;
Out::ConversionNotImplemented;
}

Expand All @@ -582,8 +611,9 @@ namespace ignition
/// \return Conversion result.
/// \tparam Out Output type.
template<class Out>
Out convert(const std::string &/*_in*/)
Out convert(const std::string &_in)
{
(void)_in;
Out::ConversionNotImplemented;
}

Expand All @@ -598,8 +628,9 @@ namespace ignition
/// \return Conversion result.
/// \tparam Out Output type.
template<class Out>
Out convert(const math::AxisAlignedBox &/*_in*/)
Out convert(const math::AxisAlignedBox &_in)
{
(void)_in;
Out::ConversionNotImplemented;
}

Expand All @@ -616,8 +647,9 @@ namespace ignition
/// \return Conversion result.
/// \tparam Out Output type.
template<class Out>
Out convert(const msgs::AxisAlignedBox &/*_in*/)
Out convert(const msgs::AxisAlignedBox &_in)
{
(void)_in;
Out::ConversionNotImplemented;
}

Expand Down
Loading