gz-cmake icon indicating copy to clipboard operation
gz-cmake copied to clipboard

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

Open osrf-migration opened this issue 7 years ago • 2 comments

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


  • ////////////////////////////////////////////////// inside a code block is ignored.
  • \brief is 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:

![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 avatar Mar 09 '18 17:03 osrf-migration

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


  • Edited issue description

osrf-migration avatar Mar 10 '18 10:03 osrf-migration

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

azeey avatar Oct 05 '23 17:10 azeey