search

GrammaTech / gtirb

Intermediate Representation for Binary analysis and transformation
https://grammatech.github.io/gtirb/
Other
305 stars 36 forks source link

More API doxygen work #16

Closed AmyGale closed 5 years ago

AmyGale commented 5 years ago

Created several doxygen "groups" to gather together documentation for related functionality that is not otherwise encapsulated.

Added \file entries to all files except those that are not originally ours.

Added doxygen comment skeletons to namespaces gtirb, details, table.

Added assorted \relates markings so that gtirb-level functions that are related to specific classes are noted in the documentation for those classes.

Functions in Context.hpp that have unnamed parameters have had their documentation skeletons adjusted to allow for documenting those parameters in a more or less doxygen-friendly way (it can't directly cope with unnamed parameters). Any functions in other files that have unnamed parameters will be adjusted as I come across them

nweston commented 5 years ago

Is this branch done/ready for review? I keeping seeing new commits come in.

AmyGale commented 5 years ago

It is ready for review, I just keep adding things while I see it's still open

AmyGale commented 5 years ago

It is ready for review, I just keep adding things while I see it's still open

I won't add any more

nweston commented 5 years ago

I fixed one small indentation issue. In the future please make sure your editor is configured to use spaces only, no tabs. Or better yet, run things through clang-format after editing them.