couchbaselabs / couchbaselabs/mini-hacks

attach Couchbase Lite javadoc/sources in default project

Open
#8 0 comments 0 reactions 1 assignee Claimed by @zgramana View on GitHub
enhancement
Dominant language
Java
Stars
137
Forks
54
PR merge metrics
No merged PRs in 30d

Description

I had a reason to add some addtional logging messages, and I found the Log.e() and friends in the MainActivity class, but neither javadoc or code are attached so I'm pretty much guessing at the API. Specifically, the TAG.

This also hampers other grokking of the API, since I can't just hover or command-click on a method to see what it does. For example, I can't click through to see what methods there are on Manager or what overloads of getDatabase() may exist.

I didn't find it here either:
http://developer.couchbase.com/mobile/develop/references/couchbase-lite/couchbase-lite/index.html

I'm not sure how hard it is, but it'd be a useful enhancement to have the javadoc or sources attached. I know this follows the android.util.Log class, but since it's pointing to our own com.couchbase.lite.util, it's up to us to link the javadoc.

Perhaps this is actually a bug? I don't actually see a good reason for us to be using a Couchbase extended class for logging in a sample app over the canonical logging methods.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.