Improve the documentation for Tool and Repository classes.
Review Request #10768 — Created Oct. 28, 2019 and submitted
The
Tool
andRepository
classes are pretty fundamental to the
product, but are a bit of a mess. Some upcoming work will be changing
these classes some, and it felt like a good time to make sure we had
properly brought this up to modern standards.This change adds and rewrites documentation for these classes, making
types, exceptions, and behaviors a lot more clear. The classes and
methods can now be better understood when viewing the generated
documentation.The next change in this series will rearrange some methods in the
Repository
class in order to better keep the class organized going
forward.
Built the docs. Checked to make sure there weren't any build errors
or broken links.
- Change Summary:
-
Added a missing change to a variable rename that ended up in another commit.
- Commit:
-
fdfe1c5d2ab14d827884a28c6d9ef13de6607615eccfc699797269ba571c6f26d2e2574d2b4fcff1
- Diff:
-
Revision 2 (+369 -34)