Collapse single-line javadoc comments

barteksc · barteksc · commit 2f35f0f845a1 · 2017-11-12T12:49:47.000+01:00
diff --git a/android-pdf-viewer/src/main/java/com/github/barteksc/pdfviewer/PDFView.java b/android-pdf-viewer/src/main/java/com/github/barteksc/pdfviewer/PDFView.java
@@ -109,26 +109,18 @@ enum ScrollDir {
 
     private ScrollDir scrollDir = ScrollDir.NONE;
 
-    /**
-     * Rendered parts go to the cache manager
-     */
+    /** Rendered parts go to the cache manager */
     CacheManager cacheManager;
 
-    /**
-     * Animation manager manage all offset and zoom animation
-     */
+    /** Animation manager manage all offset and zoom animation */
     private AnimationManager animationManager;
 
-    /**
-     * Drag manager manage all touch events
-     */
+    /** Drag manager manage all touch events */
     private DragPinchManager dragPinchManager;
 
     PdfFile pdfFile;
 
-    /**
-     * The index of the current sequence
-     */
+    /** The index of the current sequence */
     private int currentPage;
 
     /**
@@ -145,68 +137,46 @@ enum ScrollDir {
      */
     private float currentYOffset = 0;
 
-    /**
-     * The zoom level, always >= 1
-     */
+    /** The zoom level, always >= 1 */
     private float zoom = 1f;
 
-    /**
-     * True if the PDFView has been recycled
-     */
+    /** True if the PDFView has been recycled */
     private boolean recycled = true;
 
-    /**
-     * Current state of the view
-     */
+    /** Current state of the view */
     private State state = State.DEFAULT;
 
-    /**
-     * Async task used during the loading phase to decode a PDF document
-     */
+    /** Async task used during the loading phase to decode a PDF document */
     private DecodingAsyncTask decodingAsyncTask;
 
-    /**
-     * The thread {@link #renderingHandler} will run on
-     */
+    /** The thread {@link #renderingHandler} will run on */
     private final HandlerThread renderingHandlerThread;
-    /**
-     * Handler always waiting in the background and rendering tasks
-     */
+    /** Handler always waiting in the background and rendering tasks */
     RenderingHandler renderingHandler;
 
     private PagesLoader pagesLoader;
 
     Callbacks callbacks = new Callbacks();
 
-    /**
-     * Paint object for drawing
-     */
+    /** Paint object for drawing */
     private Paint paint;
 
-    /**
-     * Paint object for drawing debug stuff
-     */
+    /** Paint object for drawing debug stuff */
     private Paint debugPaint;
 
-    /**
-     * Policy for fitting pages to screen
-     */
+    /** Policy for fitting pages to screen */
     private FitPolicy pageFitPolicy = FitPolicy.WIDTH;
 
     private int defaultPage = 0;
 
-    /**
-     * True if should scroll through pages vertically instead of horizontally
-     */
+    /** True if should scroll through pages vertically instead of horizontally */
     private boolean swipeVertical = true;
 
     private boolean enableSwipe = true;
 
     private boolean doubletapEnabled = true;
 
-    /**
-     * Pdfium core for loading and rendering PDFs
-     */
+    /** Pdfium core for loading and rendering PDFs */
     private PdfiumCore pdfiumCore;
 
     private ScrollHandle scrollHandle;
@@ -237,26 +207,18 @@ ScrollHandle getScrollHandle() {
      */
     private boolean renderDuringScale = false;
 
-    /**
-     * Antialiasing and bitmap filtering
-     */
+    /** Antialiasing and bitmap filtering */
     private boolean enableAntialiasing = true;
     private PaintFlagsDrawFilter antialiasFilter =
             new PaintFlagsDrawFilter(0, Paint.ANTI_ALIAS_FLAG | Paint.FILTER_BITMAP_FLAG);
 
-    /**
-     * Spacing between pages, in px
-     */
+    /** Spacing between pages, in px */
     private int spacingPx = 0;
 
-    /**
-     * pages numbers used when calling onDrawAllListener
-     */
+    /** pages numbers used when calling onDrawAllListener */
     private List<Integer> onDrawPagesNums = new ArrayList<>(10);
 
-    /**
-     * Construct the initial view
-     */
+    /** Construct the initial view */
     public PDFView(Context context, AttributeSet set) {
         super(context, set);
 
@@ -449,9 +411,7 @@ public boolean isRecycled() {
         return recycled;
     }
 
-    /**
-     * Handle fling animation
-     */
+    /** Handle fling animation */
     @Override
     public void computeScroll() {
         super.computeScroll();
@@ -626,9 +586,7 @@ private void drawWithListener(Canvas canvas, int page, OnDrawListener listener)
         }
     }
 
-    /**
-     * Draw a given PagePart on the canvas
-     */
+    /** Draw a given PagePart on the canvas */
     private void drawPart(Canvas canvas, PagePart part) {
         // Can seem strange, but avoid lot of calls
         RectF pageRelativeBounds = part.getPageRelativeBounds();
@@ -708,9 +666,7 @@ public void loadPages() {
         redraw();
     }
 
-    /**
-     * Called when the PDF is loaded
-     */
+    /** Called when the PDF is loaded */
     void loadComplete(PdfFile pdfFile) {
         state = State.LOADED;
 
@@ -1126,41 +1082,32 @@ public List<PdfDocument.Link> getLinks(int page) {
         return pdfFile.getPageLinks(page);
     }
 
-    /**
-     * Use an asset file as the pdf source
-     */
+    /** Use an asset file as the pdf source */
     public Configurator fromAsset(String assetName) {
         return new Configurator(new AssetSource(assetName));
     }
 
-    /**
-     * Use a file as the pdf source
-     */
+    /** Use a file as the pdf source */
     public Configurator fromFile(File file) {
         return new Configurator(new FileSource(file));
     }
 
-    /**
-     * Use URI as the pdf source, for use with content providers
-     */
+    /** Use URI as the pdf source, for use with content providers */
     public Configurator fromUri(Uri uri) {
         return new Configurator(new UriSource(uri));
     }
 
-    /**
-     * Use bytearray as the pdf source, documents is not saved
-     */
+    /** Use bytearray as the pdf source, documents is not saved */
     public Configurator fromBytes(byte[] bytes) {
         return new Configurator(new ByteArraySource(bytes));
     }
 
+    /** Use stream as the pdf source. Stream will be written to bytearray, because native code does not support Java Streams */
     public Configurator fromStream(InputStream stream) {
         return new Configurator(new InputStreamSource(stream));
     }
 
-    /**
-     * Use custom source as pdf source
-     */
+    /** Use custom source as pdf source */
     public Configurator fromSource(DocumentSource docSource) {
         return new Configurator(docSource);
     }
