gz-cmake
gz-cmake copied to clipboard
Tutorial documentation doesn't parse `///` and `\`
Original report (archived issue) by Carlos Agüero (Bitbucket: caguero, GitHub: caguero).
//////////////////////////////////////////////////inside a code block is ignored.\briefis extracted from the code block and rendered before the code snippet. Probably because is a Doxygen reserved word.
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:

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;
}

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