Improve GdbStubStateMachine API Docs

[daniel5151]

To avoid blocking the release of 0.6 any longer, I've decided to leave this bit of the API sparsely documented for now.

While all the API types and methods have been documented, there isn't any good mod-level docs on how to use the various types. Instead, I've just pointed folks at various bits of real-world example code.