Return-Path: X-Original-To: apmail-commons-commits-archive@minotaur.apache.org Delivered-To: apmail-commons-commits-archive@minotaur.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id 71245996D for ; Fri, 23 Sep 2011 15:58:15 +0000 (UTC) Received: (qmail 67838 invoked by uid 500); 23 Sep 2011 15:58:15 -0000 Delivered-To: apmail-commons-commits-archive@commons.apache.org Received: (qmail 67779 invoked by uid 500); 23 Sep 2011 15:58:15 -0000 Mailing-List: contact commits-help@commons.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@commons.apache.org Delivered-To: mailing list commits@commons.apache.org Received: (qmail 67771 invoked by uid 99); 23 Sep 2011 15:58:15 -0000 Received: from nike.apache.org (HELO nike.apache.org) (192.87.106.230) by apache.org (qpsmtpd/0.29) with ESMTP; Fri, 23 Sep 2011 15:58:15 +0000 X-ASF-Spam-Status: No, hits=-2000.0 required=5.0 tests=ALL_TRUSTED X-Spam-Check-By: apache.org Received: from [140.211.11.4] (HELO eris.apache.org) (140.211.11.4) by apache.org (qpsmtpd/0.29) with ESMTP; Fri, 23 Sep 2011 15:58:12 +0000 Received: from eris.apache.org (localhost [127.0.0.1]) by eris.apache.org (Postfix) with ESMTP id A67A823889E7 for ; Fri, 23 Sep 2011 15:57:51 +0000 (UTC) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r1174852 - /commons/proper/functor/trunk/src/main/java/org/apache/commons/functor/core/algorithm/FoldLeft.java Date: Fri, 23 Sep 2011 15:57:51 -0000 To: commits@commons.apache.org From: simonetripodi@apache.org X-Mailer: svnmailer-1.0.8-patched Message-Id: <20110923155751.A67A823889E7@eris.apache.org> X-Virus-Checked: Checked by ClamAV on apache.org Author: simonetripodi Date: Fri Sep 23 15:57:51 2011 New Revision: 1174852 URL: http://svn.apache.org/viewvc?rev=1174852&view=rev Log: added missing javadoc comments Modified: commons/proper/functor/trunk/src/main/java/org/apache/commons/functor/core/algorithm/FoldLeft.java Modified: commons/proper/functor/trunk/src/main/java/org/apache/commons/functor/core/algorithm/FoldLeft.java URL: http://svn.apache.org/viewvc/commons/proper/functor/trunk/src/main/java/org/apache/commons/functor/core/algorithm/FoldLeft.java?rev=1174852&r1=1174851&r2=1174852&view=diff ============================================================================== --- commons/proper/functor/trunk/src/main/java/org/apache/commons/functor/core/algorithm/FoldLeft.java (original) +++ commons/proper/functor/trunk/src/main/java/org/apache/commons/functor/core/algorithm/FoldLeft.java Fri Sep 23 15:57:51 2011 @@ -43,12 +43,23 @@ public class FoldLeft implements Unar * Helper procedure. */ private static class FoldLeftHelper implements UnaryProcedure { + /** + * The wrapped function. + */ private final BinaryFunction function; + /** + * The seed object. + */ private T seed; + /** + * Flag to check the helper started or not. + */ private boolean started; /** * Create a seedless FoldLeftHelper. + * + * @param function The wrapped function */ public FoldLeftHelper(BinaryFunction function) { this(null, function); @@ -56,7 +67,9 @@ public class FoldLeft implements Unar /** * Create a new FoldLeftHelper. + * * @param seed initial left-side argument + * @param function The wrapped function */ FoldLeftHelper(T seed, BinaryFunction function) { this.seed = seed; @@ -86,6 +99,9 @@ public class FoldLeft implements Unar } + /** + * {@link BinaryFunction} to apply to each (seed, next). + */ private final BinaryFunction function; /**