[Android] Document libVLC getters

Jean-Baptiste Kempf git at videolan.org
Mon Oct 15 12:29:27 CEST 2012


vlc-ports/android | branch: master | Jean-Baptiste Kempf <jb at videolan.org> | Mon Oct 15 12:29:02 2012 +0200| [235a3f1aa07c4fb5cc75e4b573240b7f820513cd] | committer: Jean-Baptiste Kempf

Document libVLC getters

> http://git.videolan.org/gitweb.cgi/vlc-ports/android.git/?a=commit;h=235a3f1aa07c4fb5cc75e4b573240b7f820513cd
---

 vlc-android/src/org/videolan/vlc/LibVLC.java |   14 ++++++++++----
 1 file changed, 10 insertions(+), 4 deletions(-)

diff --git a/vlc-android/src/org/videolan/vlc/LibVLC.java b/vlc-android/src/org/videolan/vlc/LibVLC.java
index 873574e..4dcce9e 100644
--- a/vlc-android/src/org/videolan/vlc/LibVLC.java
+++ b/vlc-android/src/org/videolan/vlc/LibVLC.java
@@ -87,10 +87,10 @@ public class LibVLC {
     }
 
     /**
-     * Singleton constructor
-     * Without surface and vout to create the thumbnail and get information
-     * e.g. on the MediaLibraryAcitvity
-     * @return
+     * Singleton constructor of libVLC Without surface and vout to create the
+     * thumbnail and get information e.g. on the MediaLibraryActivity
+     * 
+     * @return libVLC instance
      * @throws LibVlcException
      */
     public static LibVLC getInstance() throws LibVlcException {
@@ -105,6 +105,12 @@ public class LibVLC {
         return sInstance;
     }
 
+    /**
+     * Return an existing instance of libVLC Call it when it is NOT important
+     * that this fails
+     * 
+     * @return libVLC instance OR null
+     */
     public static LibVLC getExistingInstance() {
         synchronized (LibVLC.class) {
             return sInstance;



More information about the Android mailing list