Is there a "markup language" to describe a debugging session?
I want to document my debugging sessions in a text file but I don’t know if anyone did this before.
I came up with this kind of “language” that is a mix between Markdown and C++, but I still wonder if something equivalent exists already.
<span style="color:#323232;">// When you click on the button
</span><span style="color:#323232;"># [click button]
</span><span style="color:#323232;">- A::f()
</span><span style="color:#323232;">// - ... other method calls, don't document if you don't need to
</span><span style="color:#323232;">
</span><span style="color:#323232;"># A::f()
</span><span style="color:#323232;">// "..." for "parameters" where you don't need the details
</span><span style="color:#323232;">- Stuff::g(...)
</span><span style="color:#323232;">- Stuff::h(...)
</span><span style="color:#323232;">
</span><span style="color:#323232;">// <Class> is a fake template thing to show the possible types of an object
</span><span style="color:#323232;"># <SubStuffA | SubStuffB> Stuff::g(...)
</span><span style="color:#323232;">- Stuff::g() {} // empty but I use v/=> for virtual call
</span><span style="color:#323232;"> v/=> SubStuffA::g()
</span><span style="color:#323232;"> v/=> SubStuffB::g()
</span><span style="color:#323232;">
</span><span style="color:#323232;"># SubStuffA::g()
</span><span style="color:#323232;">
</span><span style="color:#323232;"># SubStuffB::g()
</span><span style="color:#323232;">
</span><span style="color:#323232;"># Stuff::h(...)
</span>
I document methods in the order of appearance in the code.
If you have any good idea about a reliable way to document a list of function calls, I’m interested!
Add comment