Uploaded image for project: 'Couchbase Java Client'
  1. Couchbase Java Client
  2. JCBC-155

add javadoc for AbstractView, View, SpatialView

    Details

    • Type: Improvement
    • Status: Resolved
    • Priority: Critical
    • Resolution: Fixed
    • Affects Version/s: 1.1-dp4
    • Fix Version/s: 1.1-beta
    • Component/s: Documentation
    • Security Level: Public
    • Labels:
      None

      Description

      When fixing up a test after a merge commit, I noted that I had to create a View object directly. In the process, I found that many of these classes are public, have public ctors, but have no javadoc. The client API takes AbstractView as an argument, so it may be tempting to just construct one. Is it correct to do so? Maybe. Javadoc doesn't tell me much.

      The arguments to the ctors could also be expanded as they're a bit outside code style. Specifically, variable names should be meaningful and at least three or more characters if the variable is to be around for a while.

      No reviews matched the request. Check your Options in the drop-down menu of this sections header.

        Activity

        Show
        daschl Michael Nitschinger added a comment - http://review.couchbase.org/#/c/22872/
        Hide
        daschl Michael Nitschinger added a comment -

        Pushed to master, will be available in dp5/beta.

        Show
        daschl Michael Nitschinger added a comment - Pushed to master, will be available in dp5/beta.

          People

          • Assignee:
            daschl Michael Nitschinger
            Reporter:
            ingenthr Matt Ingenthron
          • Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Gerrit Reviews

              There are no open Gerrit changes