javadoc for base [graph] #548
Conversation
jshook
requested review from
MarkWolters,
marianotepper and
tlwillke
as code owners
|
Before you submit for review:
If you did not complete any of these, then please explain below. |
marianotepper
left a comment
marianotepper
left a comment
There was a problem hiding this comment.
Had a couple of comments. It looks good overall.
| * @param <T> the type of the output writer | ||
| */ | ||
| public abstract class AbstractGraphIndexWriter<T extends IndexWriter> implements GraphIndexWriter { | ||
| /** EOF magic number. */ |
There was a problem hiding this comment.
This magic number does not mark EOF.
There was a problem hiding this comment.
Is the next line 33, incorrect then?
public static final int FOOTER_MAGIC = 0x4a564244; // "EOF magic"
There was a problem hiding this comment.
What would you suggest as a better description here?
There was a problem hiding this comment.
It's a magic marker that is used to check for the presence of a footer.
| * @param startOffset the start offset | ||
| * @throws IOException if an I/O error occurs | ||
| */ | ||
| public synchronized void writeHeader(ImmutableGraphIndex.View view, long startOffset) throws IOException { |
There was a problem hiding this comment.
Should this methods be made protected? @sam-herman @michaeljmarshall do we really need it public?
There was a problem hiding this comment.
@marianotepper can we make the doc improvements anyway, given these two things are orthogonal?
There was a problem hiding this comment.
I'd rather not, because the javadoc is trying to explain why the method is public, which may be just a fluke.
This is the 2nd of the javadoc backfill PRs, covering only minor elisions in the base graph package.