We need to cleanup the in-code documentation to use the same format everywhere.

I think we are going to go with the gtk-doc format since it can win us gobject-introspection (for dynamic language support for free).

We can then add gtk-doc support to autogen.sh/configure.ac/etc.

You can see a small example here: http://hergert.me/docs/libbson/bson-BSON-Documents.html