gazebosim / gz-cmake

A set of CMake modules that are used by the C++-based Gazebo projects.
https://gazebosim.org/libs/cmake
Apache License 2.0
24 stars 29 forks source link

Tutorial documentation doesn't parse `///` and `\` #22

Open osrf-migration opened 6 years ago

osrf-migration commented 6 years ago

Original report (archived issue) by Carlos Agüero (Bitbucket: caguero, GitHub: caguero).


Here's the result of generating documentation for this tutorial:

#!python

 # Test

 Here's a code snippet:

 ```{.cpp}
 //////////////////////////////////////////////////
 /// \brief Provide an "echo" service.
 bool srvEcho(const ignition::msgs::StringMsg &_req,
   ignition::msgs::StringMsg &_rep)
 {
   // Set the response's content.
   _rep.set_data(_req.data());

   // The response succeed.
   return true;
 }

And this is how it looks:

![code_snippet_1.png](https://osrf-migration.github.io/ignition-gh-pages/data/bitbucket.org/repo/Gg8npGe/images/2511738915-code_snippet_1.png)

Here's the result of generating documentation for this tutorial:

!python

Test

The same tutorial without the separator and doxygen tag:

 bool srvEcho(const ignition::msgs::StringMsg &_req,
   ignition::msgs::StringMsg &_rep)
 {
   // Set the response's content.
   _rep.set_data(_req.data());

   // The response succeed.
   return true;
 }


![code_snippet_2.png](https://osrf-migration.github.io/ignition-gh-pages/data/bitbucket.org/repo/Gg8npGe/images/176048270-code_snippet_2.png)
osrf-migration commented 6 years ago

Original comment by Carlos Agüero (Bitbucket: caguero, GitHub: caguero).


azeey commented 11 months ago

@caguero this seems like an issue with doxygen and not something gz-cmake can fix. Is it okay if we close this issue?