jessevdk / cldoc

clang based documentation generator for C and C++
GNU General Public License v2.0
553 stars 59 forks source link

Problem understanding how to write examples in comment #65

Open RedX2501 opened 10 years ago

RedX2501 commented 10 years ago

I'm trying to understand how i should write examples in comments.

https://github.com/jessevdk/cldoc/blob/master/cldoc/comment.py#L154 it seems that the splitting is done.

But after trying various formats i could not figure out how to do it and nowhere in the docs/examples/tests i could find anything.

Can you please provide an example?