Details
-
Epic
-
Resolution: Unresolved
-
Major
-
3.2.4
-
None
-
1
Description
Improve the API reference for SDK 3.x
for example, in this getAsync method, there are no possible thrown exceptions that can be easily found without digging or experimenting in the code.
for example
GetAsync method could return DocumentNotFoundException, but also other exceptions, and there is no way of discovering it.
Example:
https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/xmldoc/recommended-tags#exception
Attachments
Gerrit Reviews
For Gerrit Dashboard: NCBC-3048 | ||||||
---|---|---|---|---|---|---|
# | Subject | Branch | Project | Status | CR | V |
174182,5 | NCBC-3152: Improved code documention for KV API | master | couchbase-net-client | Status: MERGED | +2 | +1 |