Open bradfordelliott opened 9 years ago
Add tags for preconditions, postconditions, sideeffects, statespace when documenting methods. I'm currently missing this in shorte.
/** * This is my prototype * * @preconditions * ... * @postconditions * ... * @sideeffects * ... * @statespace * ... */
Would also be nice to support conditionals in examples. For example:
/** * This is my prototype * * ... * @example: if("SIMPLEX") * simplex example here * * @example: if("DUPLEX") * duplex example here */
Add tags for preconditions, postconditions, sideeffects, statespace when documenting methods. I'm currently missing this in shorte.
Would also be nice to support conditionals in examples. For example: