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

Bikas Saha commented on TEZ-1334:
---------------------------------

FileBasedKVWriter should probably be private since what the user gets is a 
KVWriter. We dont want the user to know if its file/hdfs/memory etc. Same 
reason why ShuffledUnorderedKVReader is private.

Should probably be Unstable
+@Public
+@Evolving
 public class MemoryUpdateCallbackHandler extends MemoryUpdateCallback {

Combiner should be private. MRCombiner should be public. I dont think we want 
users to use the current RawKVIterator based combiner.

This should probably not be public. Its does not seem actionable by the user. 
Maybe delete and replace with TezUncheckedException. In any case, it should 
derive from TezUncheckedException which is the base class for all Tez unchecked 
exceptions.

My bad. This should be unstable as TezClient.prewarm() itself is unstable.
-@Unstable
+@Public
+@Evolving
 public class PreWarmProcessor extends SimpleProcessor {

@private for this. Its configs are all @private
+@Unstable
 public class WeightedScalingMemoryDistributor implements 
InitialMemoryAllocator {

Do the javadocs look good on all the outputs, inputs, configurers and 
processors?






> Annotate all non public classes in tez-runtime-library with @private
> --------------------------------------------------------------------
>
>                 Key: TEZ-1334
>                 URL: https://issues.apache.org/jira/browse/TEZ-1334
>             Project: Apache Tez
>          Issue Type: Sub-task
>            Reporter: Bikas Saha
>            Assignee: Hitesh Shah
>            Priority: Blocker
>         Attachments: TEZ-1334.1.patch
>
>
> This prevents javadoc from being generated.
> Alternative would be to mark classes explicitly public using annotation.



--
This message was sent by Atlassian JIRA
(v6.2#6252)

Reply via email to