Adding doxygen documentation for VTR utilities #1597
Conversation
MohamedElgammal
changed the title
There was a problem hiding this comment.
Overall looks good Mohamed.
It seems like all the .rst files are under api/vpr, since these are all part of libvtrutil (which is separate from VPR), it seems like they should be under doc/src/api/vtrutil or doc/src/api/libvtrutil.
Similarly in RTD, this documentation shows up under the VPR API header, It should probably be under a separate heading (e.g. vtrutil API)
|
@kmurray I have moved the docs to a new header that is called VTRUTIL API instead of VPR API and changed the .rst files paths accordingly. |
There was a problem hiding this comment.
LGTM. There are some typos, but the doxygen setup looks good. I can see that the docs generated do contain the full VTR APIs, and that looks good as well.
There are several API header files that do lack a file-scope doxygen comment. Is this intended to be left out? Not a big issue, but there is a little inconsistency with other files which do have a file-scope doxygen comment.
| @@ -5,19 +5,21 @@ | |||
|
|
|||
There was a problem hiding this comment.
Missing a file description? (Not sure if it is needed in this case, but it is worth keeping consistency with other headers)
MohamedElgammal
force-pushed
the
vtrutil_doxygen_comments
branch
from
895964c to
4b3d0ba
Compare
Description
In this PR, I am adding a documentation for the supported VTR utilities in libs/libvtrutil/ path. The documentation was added by adding doxygen-compatible comments to the source.
The main target of the docs are:
Motivation and Context
This PR should help new developers to easily understand the utilities supported by vtr and use them more efficiently.
How Has This Been Tested?
To generate the docs:
cd docs/directorymake htmlThe newly added documentations are in VPR API section, under Utilities title
Types of changes
Checklist: