nifi-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "ASF subversion and git services (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (NIFI-836) Cleanup Javadoc @link elements to point to correct package names
Date Thu, 10 Sep 2015 16:06:46 GMT

    [ https://issues.apache.org/jira/browse/NIFI-836?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14738994#comment-14738994
] 

ASF subversion and git services commented on NIFI-836:
------------------------------------------------------

Commit a83ed34f91432de22552b8ab1abfd7791fbb4412 in nifi's branch refs/heads/master from [~JPercivall]
[ https://git-wip-us.apache.org/repos/asf?p=nifi.git;h=a83ed34 ]

Commit for NIFI-836 to fix broken javadoc @link elements

Signed-off-by: Matt Gilman <matt.c.gilman@gmail.com>


> Cleanup Javadoc @link elements to point to correct package names
> ----------------------------------------------------------------
>
>                 Key: NIFI-836
>                 URL: https://issues.apache.org/jira/browse/NIFI-836
>             Project: Apache NiFi
>          Issue Type: Improvement
>          Components: Documentation & Website
>            Reporter: Aldrin Piri
>            Priority: Minor
>         Attachments: NIFI-836.patch
>
>
> There are currently several Javadoc links throughout the codebase that point to the wrong
package structure, typically nifi.* instead of org.apache.nifi.*
> An exhaustive (?) listing:
> {code}
> ± % grep -nR "link nifi." nifi
> nifi/nifi-api/src/main/java/org/apache/nifi/annotation/behavior/SupportsBatching.java:30:
* {@link nifi.processor.ProcessSession ProcessSession}s' commits, as well as
> nifi/nifi-api/src/main/java/org/apache/nifi/annotation/behavior/SupportsBatching.java:33:
* {@link nifi.processor.ProcessSessionFactory ProcessSessionFactory}.
> nifi/nifi-api/src/main/java/org/apache/nifi/annotation/behavior/SupportsBatching.java:34:
* {@link nifi.processor.ProcessSessionFactory#createSession() createSession()}.
> nifi/nifi-api/src/main/java/org/apache/nifi/annotation/behavior/SupportsBatching.java:37:
* {@link nifi.processor.ProcessSession#commit() ProcessSession.commit()} may
> nifi/nifi-api/src/main/java/org/apache/nifi/controller/annotation/OnConfigured.java:31:
* {@link nifi.controller.ConfigurationContext ConfigurationContext}.
> nifi/nifi-api/src/main/java/org/apache/nifi/controller/repository/FlowFileRecord.java:45:
    * {@link nifi.controller.repository.ContentRepository ContentRepository}
> nifi/nifi-api/src/main/java/org/apache/nifi/processor/annotation/OnScheduled.java:32:
* {@link nifi.processor.SchedulingContext SchedulingContext}.
> nifi/nifi-api/src/main/java/org/apache/nifi/processor/annotation/SupportsBatching.java:30:
* {@link nifi.processor.ProcessSession ProcessSession}s' commits, as well as
> nifi/nifi-api/src/main/java/org/apache/nifi/processor/annotation/SupportsBatching.java:33:
* {@link nifi.processor.ProcessSessionFactory ProcessSessionFactory}.{@link nifi.processor.ProcessSessionFactory#createSession()
createSession()}.
> nifi/nifi-api/src/main/java/org/apache/nifi/processor/annotation/SupportsBatching.java:36:
* {@link nifi.processor.ProcessSession#commit() ProcessSession.commit()} may
> nifi/nifi-api/src/main/java/org/apache/nifi/processor/ProcessorInitializationContext.java:25:
* {@link nifi.processor.Processor Processor}s access to objects that may be of
> nifi/nifi-api/src/main/java/org/apache/nifi/provenance/ProvenanceEventType.java:74: 
   * {@link nifi.processor.Relationship Relationship} and should provide
> nifi/nifi-api/src/main/java/org/apache/nifi/provenance/ProvenanceReporter.java:208: 
   * {@link nifi.processor.ProcessSession ProcessSession} to which this
> nifi/nifi-api/src/main/java/org/apache/nifi/provenance/ProvenanceReporter.java:230: 
   * {@link nifi.processor.ProcessSession ProcessSession} to which this
> nifi/nifi-api/src/main/java/org/apache/nifi/provenance/ProvenanceReporter.java:252: 
   * {@link nifi.processor.ProcessSession ProcessSession} to which this
> nifi/nifi-api/src/main/java/org/apache/nifi/provenance/ProvenanceReporter.java:276: 
   * {@link nifi.processor.ProcessSession ProcessSession} to which this
> nifi/nifi-mock/src/main/java/org/apache/nifi/util/MockProcessSession.java:144:     *
{@link nifi.processor.Processor#onTrigger} commits or rolls back the
> nifi/nifi-mock/src/main/java/org/apache/nifi/util/MockProcessSession.java:153:     *
of {@link nifi.processor.Processor#onTrigger} commits or rolls back the
> nifi/nifi-mock/src/main/java/org/apache/nifi/util/TestRunner.java:92:     * {@link nifi.processor.annotation.OnScheduled
@OnScheduled} annotation. If
> nifi/nifi-mock/src/main/java/org/apache/nifi/util/TestRunner.java:107:     * {@link nifi.processor.annotation.OnUnscheduled
@OnUnscheduled} annotation
> nifi/nifi-mock/src/main/java/org/apache/nifi/util/TestRunner.java:117:     * {@link nifi.processor.annotation.OnStopped
@OnStopped} annotation.
> nifi/nifi-mock/src/main/java/org/apache/nifi/util/TestRunner.java:123:     * annotated
with {@link nifi.processor.annotation.OnStopped @OnStopped}
> nifi/nifi-mock/src/main/java/org/apache/nifi/util/TestRunner.java:135:     * {@link nifi.processor.annotation.OnScheduled
@OnScheduled} annotation. If
> nifi/nifi-mock/src/main/java/org/apache/nifi/util/TestRunner.java:150:     * {@link nifi.processor.annotation.OnUnscheduled
@OnUnscheduled} annotation
> nifi/nifi-mock/src/main/java/org/apache/nifi/util/TestRunner.java:160:     * {@link nifi.processor.annotation.OnStopped
@OnStopped} annotation.
> nifi/nifi-mock/src/main/java/org/apache/nifi/util/TestRunner.java:166:     * annotated
with {@link nifi.processor.annotation.OnStopped @OnStopped}
> nifi/nifi-mock/src/main/java/org/apache/nifi/util/TestRunner.java:169:     * processors
to stop running before calling the {@link nifi.processor.annotation.OnUnscheduled @OnUnscheduled}
annotation
> nifi/nifi-mock/src/main/java/org/apache/nifi/util/TestRunner.java:175:     * {@link nifi.processor.annotation.OnShutdown
@OnShutdown} annotation. If
> nifi/nifi-mock/src/main/java/org/apache/nifi/util/TestRunner.java:450:     * {@link nifi.processor.annotation.TriggerWhenAnyDestinationAvailable}
> nifi/nifi-mock/src/main/java/org/apache/nifi/util/TestRunner.java:462:     * {@link nifi.processor.annotation.TriggerWhenAnyDestinationAvailable}
> nifi/nifi-mock/src/main/java/org/apache/nifi/util/TestRunner.java:473:     * {@link nifi.processor.annotation.TriggerWhenAnyDestinationAvailable}
> nifi/nifi-mock/src/main/java/org/apache/nifi/util/TestRunner.java:485:     * {@link nifi.processor.annotation.TriggerWhenAnyDestinationAvailable}
> nifi/nifi-mock/src/main/java/org/apache/nifi/util/TestRunner.java:496:     * {@link nifi.controller.ControllerServiceInitializationContext
ControllerServiceInitializationContext}
> nifi/nifi-mock/src/main/java/org/apache/nifi/util/TestRunner.java:514:     * {@link nifi.controller.ControllerServiceInitializationContext
ControllerServiceInitializationContext}
> nifi/nifi-mock/src/main/java/org/apache/nifi/util/TestRunner.java:728:     * {@link nifi.components.PropertyValue#evaluateAttributeExpressions
evaluateAttributeExpressions}
> nifi/nifi-mock/src/main/java/org/apache/nifi/util/TestRunner.java:730:     * {@link nifi.components.PropertyValue#evaluateAttributeExpressions
evaluateAttributeExpressions}
> nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/scheduling/StandardProcessScheduler.java:276:
    * Starts scheduling the given processor to run after invoking all methods on the underlying
{@link nifi.processor.Processor
> nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/scheduling/StandardProcessScheduler.java:396:
    * Stops scheduling the given processor to run and invokes all methods on the underlying
{@link nifi.processor.Processor FlowFileProcessor} that are annotated with the {@link OnUnscheduled}
> nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core-api/src/main/java/org/apache/nifi/connectable/Connectable.java:225:
    * {@link nifi.processor.ProcessContext#yield() ProcessContext.yield()}
> nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core-api/src/main/java/org/apache/nifi/controller/ProcessScheduler.java:34:
    * on the underlying {@link nifi.processor.Processor FlowFileProcessor} that
> nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core-api/src/main/java/org/apache/nifi/controller/ProcessScheduler.java:45:
    * the underlying {@link nifi.processor.Processor FlowFileProcessor} that
> nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core-api/src/main/java/org/apache/nifi/controller/StandardFunnel.java:404:
    * {@link nifi.processor.ProcessContext#yield() ProcessContext.yield()}
> nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core-api/src/main/java/org/apache/nifi/groups/ProcessGroup.java:331:
    * {@link nifi.processor.annotation.OnRemoved OnRemoved} annotation will be
> {code}



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)

Mime
View raw message