[vcs-log] fix javadocs

This commit is contained in:
Julia Beliaeva
2017-09-12 19:15:37 +03:00
parent ab22b2e07c
commit 09ca331c38
4 changed files with 5 additions and 6 deletions
@@ -4,8 +4,6 @@ import org.jetbrains.annotations.NotNull;
/**
* Filter which needs {@link VcsCommitMetadata} to work.
*
* @see VcsLogGraphFilter
*/
public interface VcsLogDetailsFilter extends VcsLogFilter {
@@ -15,6 +15,7 @@
*/
package com.intellij.vcs.log;
import com.intellij.openapi.vfs.VirtualFile;
import org.jetbrains.annotations.NotNull;
import java.util.Collection;
@@ -23,8 +24,8 @@ import static com.intellij.vcs.log.VcsLogProvider.Requirements;
/**
* Extension of the standard {@link Requirements} which contains data used by some VCSs. <br/>
* An object of this object is actually passed to {@link #readFirstBlock(com.intellij.util.Consumer}, but VcsLogProviders
* which need this additional information must check for instanceof before casting & be able to fallback.
* An instance of this class is actually passed to {@link VcsLogProvider#readFirstBlock(VirtualFile, Requirements)},
* but VcsLogProviders which need this additional information must check for instanceof before casting & be able to fallback.
*/
public interface VcsLogProviderRequirementsEx extends Requirements {
@@ -9,7 +9,7 @@ import java.util.List;
* Returns the basic level of commit meta-data: author, time, subject. These details will be displayed in the log table.
* <p/>
* An instance of this object can be obtained via
* {@link VcsLogObjectsFactory#createShortDetails(Hash, List, long, VirtualFile, String, String, String)
* {@link VcsLogObjectsFactory#createShortDetails(Hash, List, long, VirtualFile, String, String, String, String, String, long)
* VcsLogObjectsFactory#createShortDetails}.
* <p/>
* It is not recommended to create a custom implementation of this interface, but if you need it, <b>make sure to implement {@code equals()}
@@ -51,7 +51,7 @@ public interface GraphColorManager<CommitId> {
* <li>Zero is returned if the given commits are equal.
* </ul>
*
* @see VcsLogRefManager#getBranchLayoutComparator()
* @see VcsLogRe#getBranchLayoutComparator()
*/
int compareHeads(CommitId head1, CommitId head2);
}