Return-Path: X-Original-To: apmail-accumulo-dev-archive@www.apache.org Delivered-To: apmail-accumulo-dev-archive@www.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id 7D61F100EB for ; Fri, 6 Dec 2013 21:33:35 +0000 (UTC) Received: (qmail 99515 invoked by uid 500); 6 Dec 2013 21:33:35 -0000 Delivered-To: apmail-accumulo-dev-archive@accumulo.apache.org Received: (qmail 99446 invoked by uid 500); 6 Dec 2013 21:33:35 -0000 Mailing-List: contact dev-help@accumulo.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@accumulo.apache.org Delivered-To: mailing list dev@accumulo.apache.org Received: (qmail 99432 invoked by uid 99); 6 Dec 2013 21:33:35 -0000 Received: from reviews-vm.apache.org (HELO reviews.apache.org) (140.211.11.40) by apache.org (qpsmtpd/0.29) with ESMTP; Fri, 06 Dec 2013 21:33:35 +0000 Received: from reviews.apache.org (localhost [127.0.0.1]) by reviews.apache.org (Postfix) with ESMTP id 0FF6B1D3D88; Fri, 6 Dec 2013 21:33:35 +0000 (UTC) Content-Type: multipart/alternative; boundary="===============7336217219196840349==" MIME-Version: 1.0 Subject: Re: Review Request 15857: ACCUMULO-1931 - Javadoc for core.data From: "Christopher Tubbs" To: "Bill Havanki" , "Christopher Tubbs" , "accumulo" , "Sean Busbey" Date: Fri, 06 Dec 2013 21:33:34 -0000 Message-ID: <20131206213334.1167.54968@reviews.apache.org> X-ReviewBoard-URL: https://reviews.apache.org Auto-Submitted: auto-generated Sender: "Christopher Tubbs" X-ReviewGroup: accumulo X-ReviewRequest-URL: https://reviews.apache.org/r/15857/ X-Sender: "Christopher Tubbs" References: <20131206192604.1168.23672@reviews.apache.org> In-Reply-To: <20131206192604.1168.23672@reviews.apache.org> Reply-To: "Christopher Tubbs" X-ReviewRequest-Repository: accumulo --===============7336217219196840349== Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit > On Dec. 6, 2013, 2:26 p.m., Sean Busbey wrote: > > core/src/main/java/org/apache/accumulo/core/data/doc-files/mutation-serialization.html, line 3 > > > > > > Just to verify, this html file will get included in the generated javadocs? > > > > Reading the javadoc plugin[1], it looks like maybe it needs to be in core/src/main/javadoc/org/apache/accumulo/core/data/doc-files/mutation-serialization.html > > > > [1]: http://maven.apache.org/plugins/maven-javadoc-plugin/examples/javadoc-resources.html > > > > Bill Havanki wrote: > It is. I'm using a capability of the javadoc tool itself[1] rather than the plugin. Interesting that there are multiple options for this. > > [1]: http://docs.oracle.com/javase/1.5.0/docs/tooldocs/windows/javadoc.html#unprocessed > > Sean Busbey wrote: > I saw that the javadoc tool will work with this location, just not sure if the javadoc Maven plugin changes the behavior. Might be worth moving it to src/main/javadoc to keep things more in line with "the Maven way." > > Bill Havanki wrote: > (Adding comment that I had sent in email, sorry for the repetition) > > It still works even under the Maven plugin, i.e., I checked by running mvn javadoc:javadoc and the file was transferred. So, leaving it where it is lets it work both with and without Maven. Why not use package-info.java, for package-level javadocs? - Christopher ----------------------------------------------------------- This is an automatically generated e-mail. To reply, visit: https://reviews.apache.org/r/15857/#review29897 ----------------------------------------------------------- On Dec. 6, 2013, 2:56 p.m., Bill Havanki wrote: > > ----------------------------------------------------------- > This is an automatically generated e-mail. To reply, visit: > https://reviews.apache.org/r/15857/ > ----------------------------------------------------------- > > (Updated Dec. 6, 2013, 2:56 p.m.) > > > Review request for accumulo. > > > Bugs: ACCUMULO-1931 > https://issues.apache.org/jira/browse/ACCUMULO-1931 > > > Repository: accumulo > > > Description > ------- > > Javadoc additions and updates to classes in org.apache.accumulo.core.data. > > > Diffs > ----- > > core/src/main/java/org/apache/accumulo/core/data/ArrayByteSequence.java eaa61b9950b691ed5955af3178a3aa939291e8bf > core/src/main/java/org/apache/accumulo/core/data/ByteSequence.java 4dc921c5efc44d374032c623f50e4218aa6c7299 > core/src/main/java/org/apache/accumulo/core/data/Column.java a56c01d6604a30153739ed1329d034e3932f2e2f > core/src/main/java/org/apache/accumulo/core/data/ColumnUpdate.java 641ca3a740ed384ab93f4b2d3c08c928daadfb2f > core/src/main/java/org/apache/accumulo/core/data/ComparableBytes.java ce61844375617c36ede5e0e411b439205329b023 > core/src/main/java/org/apache/accumulo/core/data/Condition.java fc8f2bf0394ae658bacfa94804b4b81f19a0c0c2 > core/src/main/java/org/apache/accumulo/core/data/ConstraintViolationSummary.java 2929bc610df9352374621d29caea7732bd50847d > core/src/main/java/org/apache/accumulo/core/data/Key.java de9e22d9ebff5442633dc578613fd7d033afc9c5 > core/src/main/java/org/apache/accumulo/core/data/KeyValue.java cc48322f9785ad508cc7925279f5e559629f3721 > core/src/main/java/org/apache/accumulo/core/data/Mutation.java 5e281f2bfef7e164c9f0e0c9a7132e94012d7186 > core/src/main/java/org/apache/accumulo/core/data/PartialKey.java 2049881fe26b5f237db39a412a88e2e2017f5cc9 > core/src/main/java/org/apache/accumulo/core/data/Range.java 70857348cefd0941e5ffcf6e5d569f09870101e4 > core/src/main/java/org/apache/accumulo/core/data/Value.java 7d3cf8f20aa12205d25027d6ad06e4a3f6062b2e > core/src/main/java/org/apache/accumulo/core/data/doc-files/mutation-serialization.html PRE-CREATION > core/src/main/java/org/apache/accumulo/core/util/UnsynchronizedBuffer.java b640581bebbb87f1ac9a36f71275fa5dc8ef1223 > > Diff: https://reviews.apache.org/r/15857/diff/ > > > Testing > ------- > > Compiled successfully; mvn javadoc:javadoc ran with no errors from the javadoc in this patch. > > > Thanks, > > Bill Havanki > > --===============7336217219196840349==--