c - Embed actual code as an example -
c - Embed actual code as an example -
i'm relatively new doxygen, , more doxyblocks plugin code::blocks.
i'm embedded examples of code documentation using @code , @endcode keywords, seen below:
/** check controller initialised ok, if did lock activate staying live feature @code if (s16_error == c_no_err) { x_sys_stay_alive(x_on); } @endcode */ if (s16_error == c_no_err) { x_sys_stay_alive(x_on); }
the problem quite wary of comments beingness left behind when code updated. it's quite cumbersome having code in there twice.
i tried putting /** @code */
before , counter part after code, includes */
in documentation.
is there way tackle this?
c documentation codeblocks doxygen
Comments
Post a Comment