From: tak Date: Thu, 3 Jan 2008 13:00:46 +0000 (+0000) Subject: Ruby API docs. X-Git-Url: http://vcs.maemo.org/git/?p=lms;a=commitdiff_plain;h=f59efd9a3346486e5c126e56bbc70e5dfdd3d45a Ruby API docs. --- diff --git a/www/index.html b/www/index.html index 527093b..7af5ddd 100644 --- a/www/index.html +++ b/www/index.html @@ -38,6 +38,7 @@ body {

Project

+
  • + Ruby bindings: + +

    • License

    diff --git a/www/ruby-api/classes/LightMediaScanner.html b/www/ruby-api/classes/LightMediaScanner.html new file mode 100644 index 0000000..97e5b6e --- /dev/null +++ b/www/ruby-api/classes/LightMediaScanner.html @@ -0,0 +1,131 @@ + + + + + + Module: LightMediaScanner + + + + + + + + + + +

    + + + + + + + + + + +
    ModuleLightMediaScanner
    In: + + rdoc.c + +
    + + ruby-lightmediascanner.c + +
    +
    +
    + + +
    + + + +
    + +
    +

    +LightMediaScanner is the outer module +of the LightMediaScanner Ruby +extension. +

    +

    +It doesn‘t currently perform any function other than namespacing. You +probably want to see LightMediaScanner::Scanner and LightMediaScanner::Parser . +

    + +
    + + +
    + + +
    + + + + +
    + +
    +

    Classes and Modules

    + + Class LightMediaScanner::Parser
    +Class LightMediaScanner::Scanner
    +Class LightMediaScanner::Test
    + +
    + + + + + + + + + + +
    + + +
    +

    [Validate]

    +
    + + + \ No newline at end of file diff --git a/www/ruby-api/classes/LightMediaScanner/Parser.html b/www/ruby-api/classes/LightMediaScanner/Parser.html new file mode 100644 index 0000000..0c4bf4c --- /dev/null +++ b/www/ruby-api/classes/LightMediaScanner/Parser.html @@ -0,0 +1,163 @@ + + + + + + Class: LightMediaScanner::Parser + + + + + + + + + + +
    + + + + + + + + + + + + + + +
    ClassLightMediaScanner::Parser
    In: + + rdoc.c + +
    +
    Parent: + Object +
    +
    + + +
    + + + +
    + +
    +

    +LightMediaScanner::Parser is a class to represent +a LightMediaScanner plugin. +

    + +
    + + +
    + +
    +

    Methods

    + +
    + new   +
    +
    + +
    + + + + +
    + + + + + + + + + +
    +

    Public Class methods

    + +
    + + +
    + + new(p1, p2) + +
    + +
    +

    +Parser#new +

    +

    +constructor +

    +
      +
    • p1 (parent) The Scanner to which the parser +belongs + +
      • +
    • p2 (name) path to shared object (usable by dlopen(3)). + +
      • +
    • return A new Parser + +
      • +
    +
    +
    + + +
    + + +
    + + +
    +

    [Validate]

    +
    + + + \ No newline at end of file diff --git a/www/ruby-api/classes/LightMediaScanner/Parser.src/M000012.html b/www/ruby-api/classes/LightMediaScanner/Parser.src/M000012.html new file mode 100644 index 0000000..837eb9d --- /dev/null +++ b/www/ruby-api/classes/LightMediaScanner/Parser.src/M000012.html @@ -0,0 +1,29 @@ + + + + + + new (LightMediaScanner::Parser) + + + + + 
    /**
+ *
+ * Parser#new
+ *
+ * constructor
+ *
+ * * p1 (parent) The Scanner to which the parser belongs
+ *
+ * * p2 (name) path to shared object (usable by dlopen(3)).
+ *
+ * * return A new Parser
+ *
+ */
+static VALUE parser_new(VALUE obj, VALUE parent, VALUE name) {
+
    + + \ No newline at end of file diff --git a/www/ruby-api/classes/LightMediaScanner/Scanner.html b/www/ruby-api/classes/LightMediaScanner/Scanner.html new file mode 100644 index 0000000..ed75c5e --- /dev/null +++ b/www/ruby-api/classes/LightMediaScanner/Scanner.html @@ -0,0 +1,463 @@ + + + + + + Class: LightMediaScanner::Scanner + + + + + + + + + + +
    + + + + + + + + + + + + + + +
    ClassLightMediaScanner::Scanner
    In: + + rdoc.c + +
    +
    Parent: + Object +
    +
    + + +
    + + + +
    + +
    +

    +LightMediaScanner::Scanner is a class to +represent a LightMediaScanner +instance. +

    + +
    + + +
    + +
    +

    Methods

    + +
    + add_charset   + check   + commit_interval   + commit_interval=   + db_path   + new   + process   + processing?   + remove_charset   + timeout   + timeout=   +
    +
    + +
    + + + + +
    + + + + + + + + + +
    +

    Public Class methods

    + +
    + + +
    + + new(p1) + +
    + +
    +

    +Scanner#new +

    +

    +constructor +

    +
      +
    • p1 (db_path) The path to the sqlite3 db +to be used + +
      • +
    • return A new Scanner instance + +
      • +
    +
    +
    + +

    Public Instance methods

    + +
    + + +
    + + add_charset(p1) + +
    + +
    +

    +Scanner::add_charset +

    +

    +Register a new charset encoding to be +used. +

    +

    +Throws a RuntimeError if LMS is unable to add the charset. +

    +
      +
    • p1 (charset) charset name as understood by iconv_open(3). + +
      • +
    • return charset + +
      • +
    +
    +
    + +
    + + +
    + + check(p1) + +
    + +
    +

    +Scanner::check +

    +

    +Check consistency of the given directory. +

    +
      +
    • p1 (top_path) The top directory to scan. + +
      • +
    • return 0 on success + +
      • +
    +
    +
    + +
    + + +
    + + commit_interval() + +
    + +
    +

    +Scanner::commit_interval +

    +

    +Get the number of files served between database transactions. +

    +
      +
    • return The number of files served between database transactions + +
      • +
    +
    +
    + +
    + + +
    + + commit_interval=(p1) + +
    + +
    +

    +Scanner::commit_interval= +

    +

    +Set the number of files to be served between database transactions. +

    +
      +
    • p1 (transactions) The number of files between commits + +
      • +
    • return The new number of files to be +served between database transactions + +
      • +
    +
    +
    + +
    + + +
    + + db_path() + +
    + +
    +

    +Scanner::db_path +

    +

    +Accessor for LMS DB path. +

    +
      +
    • return The database path given at creation time + +
      • +
    +
    +
    + +
    + + +
    + + process(p1) + +
    + +
    +

    +Scanner::process +

    +

    +This will add or update media found in the given directory or its children. +

    +
      +
    • p1 (top_path) The top directory to scan. + +
      • +
    • return 0 on success + +
      • +
    +
    +
    + +
    + + +
    + + processing?() + +
    + +
    +

    +Scanner::processing? +

    +

    +Checks if Light Media Scanner is being used in a +processing operation like lms_process() or lms_check(). +

    +
      +
    • return Boolean representing the instance‘s processing state + +
      • +
    +
    +
    + +
    + + +
    + + remove_charset(p1) + +
    + +
    +

    +Scanner::remove_charset +

    +

    +Forget about a registered charset encoding. +

    +

    +Throws a RuntimeError if LMS is unable to remove the charset. +

    +
      +
    • p1 (charset) charset name as understood by iconv_open(3). + +
      • +
    • return charset + +
      • +
    +
    +
    + +
    + + +
    + + timeout() + +
    + +
    +

    +Scanner::timeout +

    +

    +Get the maximum amount of milliseconds the slave can take to serve one +file. +

    +

    +If a slave takes more than this amount of milliseconds, it will be killed +and the scanner will continue with the next file. +

    +
      +
    • return The timeout in milliseconds, or +-1 on error + +
      • +
    +
    +
    + +
    + + +
    + + timeout=(p1) + +
    + +
    +

    +Scanner::timeout= +

    +

    +Set the maximum amount of milliseconds the slave can take to serve one +file. +

    +

    +If a slave takes more than this amount of milliseconds, it will be killed +and the scanner will continue with the next file. +

    +
      +
    • p1 (timeout_ms) The timeout in +milliseconds + +
      • +
    • return The new timeout, in milliseconds + +
      • +
    +
    +
    + + +
    + + +
    + + +
    +

    [Validate]

    +
    + + + \ No newline at end of file diff --git a/www/ruby-api/classes/LightMediaScanner/Scanner.src/M000001.html b/www/ruby-api/classes/LightMediaScanner/Scanner.src/M000001.html new file mode 100644 index 0000000..0b8893d --- /dev/null +++ b/www/ruby-api/classes/LightMediaScanner/Scanner.src/M000001.html @@ -0,0 +1,25 @@ + + + + + + new (LightMediaScanner::Scanner) + + + + + 
    /**
+ * Scanner#new
+ *
+ * constructor
+ *
+ * * p1 (db_path) The path to the sqlite3 db to be used
+ *
+ * * return A new Scanner instance
+ */
+static VALUE scanner_new(VALUE obj, VALUE db_path) {
+
    + + \ No newline at end of file diff --git a/www/ruby-api/classes/LightMediaScanner/Scanner.src/M000002.html b/www/ruby-api/classes/LightMediaScanner/Scanner.src/M000002.html new file mode 100644 index 0000000..fef16bd --- /dev/null +++ b/www/ruby-api/classes/LightMediaScanner/Scanner.src/M000002.html @@ -0,0 +1,27 @@ + + + + + + process (LightMediaScanner::Scanner) + + + + + 
    /**
+ *
+ * Scanner::process
+ *
+ * This will add or update media found in the given directory or its children.
+ *
+ * * p1 (top_path) The top directory to scan.
+ *
+ * * return 0 on success
+ *
+ */
+static VALUE scanner_process(VALUE self, VALUE top_path) {
+
    + + \ No newline at end of file diff --git a/www/ruby-api/classes/LightMediaScanner/Scanner.src/M000003.html b/www/ruby-api/classes/LightMediaScanner/Scanner.src/M000003.html new file mode 100644 index 0000000..3fb7078 --- /dev/null +++ b/www/ruby-api/classes/LightMediaScanner/Scanner.src/M000003.html @@ -0,0 +1,27 @@ + + + + + + check (LightMediaScanner::Scanner) + + + + + 
    /**
+ *
+ * Scanner::check
+ *
+ * Check consistency of the given directory.
+ *
+ * * p1 (top_path) The top directory to scan.
+ *
+ * * return 0 on success
+ *
+ */
+static VALUE scanner_check(VALUE self, VALUE top_path) {
+
    + + \ No newline at end of file diff --git a/www/ruby-api/classes/LightMediaScanner/Scanner.src/M000004.html b/www/ruby-api/classes/LightMediaScanner/Scanner.src/M000004.html new file mode 100644 index 0000000..2b02d78 --- /dev/null +++ b/www/ruby-api/classes/LightMediaScanner/Scanner.src/M000004.html @@ -0,0 +1,25 @@ + + + + + + db_path (LightMediaScanner::Scanner) + + + + + 
    /**
+ *
+ * Scanner::db_path
+ *
+ * Accessor for LMS DB path.
+ *
+ * * return The database path given at creation time
+ *
+ */
+static VALUE scanner_db_path(VALUE self) {
+
    + + \ No newline at end of file diff --git a/www/ruby-api/classes/LightMediaScanner/Scanner.src/M000005.html b/www/ruby-api/classes/LightMediaScanner/Scanner.src/M000005.html new file mode 100644 index 0000000..6d0abd8 --- /dev/null +++ b/www/ruby-api/classes/LightMediaScanner/Scanner.src/M000005.html @@ -0,0 +1,25 @@ + + + + + + processing? (LightMediaScanner::Scanner) + + + + + 
    /**
+ *
+ * Scanner::processing?
+ *
+ * Checks if Light Media Scanner is being used in a processing operation like lms_process() or lms_check().
+ *
+ * * return Boolean representing the instance's processing state
+ *
+ */
+static VALUE scanner_processing(VALUE self) {
+
    + + \ No newline at end of file diff --git a/www/ruby-api/classes/LightMediaScanner/Scanner.src/M000006.html b/www/ruby-api/classes/LightMediaScanner/Scanner.src/M000006.html new file mode 100644 index 0000000..afe149e --- /dev/null +++ b/www/ruby-api/classes/LightMediaScanner/Scanner.src/M000006.html @@ -0,0 +1,27 @@ + + + + + + timeout (LightMediaScanner::Scanner) + + + + + 
    /**
+ *
+ * Scanner::timeout
+ *
+ * Get the maximum amount of milliseconds the slave can take to serve one file. 
+ *
+ * If a slave takes more than this amount of milliseconds, it will be killed and the scanner will continue with the next file.
+ *
+ * * return The timeout in milliseconds, or -1 on error
+ *
+ */
+static VALUE scanner_get_slave_timeout(VALUE self) {
+
    + + \ No newline at end of file diff --git a/www/ruby-api/classes/LightMediaScanner/Scanner.src/M000007.html b/www/ruby-api/classes/LightMediaScanner/Scanner.src/M000007.html new file mode 100644 index 0000000..c0461cb --- /dev/null +++ b/www/ruby-api/classes/LightMediaScanner/Scanner.src/M000007.html @@ -0,0 +1,29 @@ + + + + + + timeout= (LightMediaScanner::Scanner) + + + + + 
    /**
+ *
+ * Scanner::timeout=
+ *
+ * Set the maximum amount of milliseconds the slave can take to serve one file.
+ *
+ * If a slave takes more than this amount of milliseconds, it will be killed and the scanner will continue with the next file.
+ *
+ * * p1 (timeout_ms) The timeout in milliseconds
+ *
+ * * return The new timeout, in milliseconds
+ *
+ */
+static VALUE scanner_set_slave_timeout(VALUE self, VALUE timeout_ms) {
+
    + + \ No newline at end of file diff --git a/www/ruby-api/classes/LightMediaScanner/Scanner.src/M000008.html b/www/ruby-api/classes/LightMediaScanner/Scanner.src/M000008.html new file mode 100644 index 0000000..bfb386a --- /dev/null +++ b/www/ruby-api/classes/LightMediaScanner/Scanner.src/M000008.html @@ -0,0 +1,25 @@ + + + + + + commit_interval (LightMediaScanner::Scanner) + + + + + 
    /**
+ *
+ * Scanner::commit_interval
+ *
+ * Get the number of files served between database transactions.
+ *
+ * * return The number of files served between database transactions
+ *
+ */
+static VALUE scanner_get_commit_interval(VALUE self) {
+
    + + \ No newline at end of file diff --git a/www/ruby-api/classes/LightMediaScanner/Scanner.src/M000009.html b/www/ruby-api/classes/LightMediaScanner/Scanner.src/M000009.html new file mode 100644 index 0000000..54e1b66 --- /dev/null +++ b/www/ruby-api/classes/LightMediaScanner/Scanner.src/M000009.html @@ -0,0 +1,27 @@ + + + + + + commit_interval= (LightMediaScanner::Scanner) + + + + + 
    /**
+ *
+ * Scanner::commit_interval=
+ *
+ * Set the number of files to be served between database transactions.
+ *
+ * * p1 (transactions) The number of files between commits
+ *
+ * * return The new number of files to be served between database transactions
+ *
+ */
+static VALUE scanner_set_commit_interval(VALUE self, VALUE transactions) {
+
    + + \ No newline at end of file diff --git a/www/ruby-api/classes/LightMediaScanner/Scanner.src/M000010.html b/www/ruby-api/classes/LightMediaScanner/Scanner.src/M000010.html new file mode 100644 index 0000000..04320ca --- /dev/null +++ b/www/ruby-api/classes/LightMediaScanner/Scanner.src/M000010.html @@ -0,0 +1,29 @@ + + + + + + add_charset (LightMediaScanner::Scanner) + + + + + 
    /**
+ *
+ * Scanner::add_charset
+ *
+ * Register a new charset encoding to be used.
+ *
+ * Throws a RuntimeError if LMS is unable to add the charset.
+ *
+ * * p1 (charset) charset name as understood by iconv_open(3).
+ *
+ * * return charset
+ *
+ */
+static VALUE scanner_add_charset(VALUE self, VALUE charset) {
+
    + + \ No newline at end of file diff --git a/www/ruby-api/classes/LightMediaScanner/Scanner.src/M000011.html b/www/ruby-api/classes/LightMediaScanner/Scanner.src/M000011.html new file mode 100644 index 0000000..aefcdab --- /dev/null +++ b/www/ruby-api/classes/LightMediaScanner/Scanner.src/M000011.html @@ -0,0 +1,29 @@ + + + + + + remove_charset (LightMediaScanner::Scanner) + + + + + 
    /**
+ *
+ * Scanner::remove_charset
+ *
+ * Forget about a registered charset encoding.
+ *
+ * Throws a RuntimeError if LMS is unable to remove the charset.
+ *
+ * * p1 (charset) charset name as understood by iconv_open(3).
+ *
+ * * return charset
+ *
+ */
+static VALUE scanner_remove_charset(VALUE self, VALUE charset) {
+
    + + \ No newline at end of file diff --git a/www/ruby-api/classes/LightMediaScanner/Test.html b/www/ruby-api/classes/LightMediaScanner/Test.html new file mode 100644 index 0000000..e318681 --- /dev/null +++ b/www/ruby-api/classes/LightMediaScanner/Test.html @@ -0,0 +1,182 @@ + + + + + + Class: LightMediaScanner::Test + + + + + + + + + + +
    + + + + + + + + + + + + + + +
    ClassLightMediaScanner::Test
    In: + + lightmediascanner-unittest.rb + +
    +
    Parent: + Test::Unit::TestCase +
    +
    + + +
    + + + +
    + +
    +

    +Test cases for LightMediaScanner. You probably +don‘t care about this. +

    + +
    + + +
    + +
    +

    Methods

    + +
    + test_module   + test_scanner_baddata   + test_scanner_gooddata   +
    +
    + +
    + + + +
    +

    Included Modules

    + + +
    + +
    + + + + + + + + + +
    +

    Public Instance methods

    + +
    + + +
    + + test_module() + +
    + +
    +
    +
    + + + + + + +
    + + +
    + + +
    +

    [Validate]

    +
    + + + \ No newline at end of file diff --git a/www/ruby-api/classes/LightMediaScanner/Test.src/M000013.html b/www/ruby-api/classes/LightMediaScanner/Test.src/M000013.html new file mode 100644 index 0000000..cf054da --- /dev/null +++ b/www/ruby-api/classes/LightMediaScanner/Test.src/M000013.html @@ -0,0 +1,19 @@ + + + + + + test_module (LightMediaScanner::Test) + + + + + 
    # File lightmediascanner-unittest.rb, line 32
+                def test_module()
+                        assert(LightMediaScanner::constants.include?('Scanner'))
+                        assert(LightMediaScanner::constants.include?('Parser'))
+                end
    + + \ No newline at end of file diff --git a/www/ruby-api/classes/LightMediaScanner/Test.src/M000014.html b/www/ruby-api/classes/LightMediaScanner/Test.src/M000014.html new file mode 100644 index 0000000..a23dd9c --- /dev/null +++ b/www/ruby-api/classes/LightMediaScanner/Test.src/M000014.html @@ -0,0 +1,38 @@ + + + + + + test_scanner_gooddata (LightMediaScanner::Test) + + + + + 
    # File lightmediascanner-unittest.rb, line 37
+                def test_scanner_gooddata()
+                        dbPath = '/'
+                        timeout = 60000
+                        commitInterval = 1000
+
+                        lms = nil
+                        assert_nothing_raised(){ lms = Scanner.new(dbPath) }
+                        assert_equal(dbPath, lms.db_path)
+
+                        lms.timeout=timeout
+                        assert_equal(lms.timeout, timeout)
+
+                        assert(!lms.processing?)
+
+                        lms.commit_interval = commitInterval
+                        assert_equal(lms.commit_interval, commitInterval)
+
+                        assert_raise(RuntimeError){ lms.process('/') }
+                        assert_raise(RuntimeError){ lms.check('/') }
+                        assert_nothing_raised(){ lms.add_charset('ISO-8859-1') }
+                        assert_nothing_raised(){ lms.remove_charset('ISO-8859-1') }
+                        assert_raise(RuntimeError){ Parser.new(lms, 'blah') }
+                end
    + + \ No newline at end of file diff --git a/www/ruby-api/classes/LightMediaScanner/Test.src/M000015.html b/www/ruby-api/classes/LightMediaScanner/Test.src/M000015.html new file mode 100644 index 0000000..e6fe821 --- /dev/null +++ b/www/ruby-api/classes/LightMediaScanner/Test.src/M000015.html @@ -0,0 +1,44 @@ + + + + + + test_scanner_baddata (LightMediaScanner::Test) + + + + + 
    # File lightmediascanner-unittest.rb, line 61
+                def test_scanner_baddata()
+                        dbPath = '/'
+                        timeout = 60000
+                        commitInterval = 1000
+
+                        lms = nil
+                        assert_raise(TypeError){ lms = Scanner.new(nil) }
+                        assert_nothing_raised(){ lms = Scanner.new(dbPath) }
+                        assert_equal(dbPath, lms.db_path)
+
+                        assert_raise(TypeError){ lms.timeout = 'Jared' }
+                        assert_raise(TypeError){ lms.timeout = 3.14159 }
+
+                        assert_raise(TypeError){ lms.commit_interval = 2.72 }
+                        assert_raise(TypeError){ lms.commit_interval = nil }
+
+                        assert_raise(TypeError){ lms.process(nil) }
+                        assert_raise(TypeError){ lms.process(3) }
+
+                        assert_raise(TypeError){ lms.check(lms) }
+                        assert_raise(TypeError){ lms.check(5.43) }
+
+                        assert_raise(TypeError){ lms.add_charset(nil) }
+                        assert_raise(TypeError){ lms.add_charset(42) }
+                        assert_raise(RuntimeError){ lms.add_charset('I CAN HAZ CHARSET?') }
+
+                        assert_raise(RuntimeError){ lms.remove_charset('EBCDIC') }
+                        assert_raise(TypeError){ lms.remove_charset(nil) }
+                end
    + + \ No newline at end of file diff --git a/www/ruby-api/created.rid b/www/ruby-api/created.rid new file mode 100644 index 0000000..ae9f217 --- /dev/null +++ b/www/ruby-api/created.rid @@ -0,0 +1 @@ +Thu, 03 Jan 2008 07:32:06 -0500 diff --git a/www/ruby-api/files/extconf_rb.html b/www/ruby-api/files/extconf_rb.html new file mode 100644 index 0000000..7e0edcf --- /dev/null +++ b/www/ruby-api/files/extconf_rb.html @@ -0,0 +1,147 @@ + + + + + + File: extconf.rb + + + + + + + + + + +
    +

    extconf.rb

    + + + + + + + + + +
    Path:extconf.rb +
    Last Update:Wed Jan 02 10:56:02 -0500 2008
    +
    + + +
    + + + +
    + +
    +

    +Copyright (C) 2007 by Levi Bard +

    +

    +This program is free software; you can redistribute it and/or modify it +under the terms of the GNU Lesser General Public License as published by +the Free Software Foundation; either version 2 of the License, or (at your +option) any later version. +

    +

    +This program is distributed in the hope that it will be useful, but WITHOUT +ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for +more details. +

    +

    +You should have received a copy of the GNU Lesser General Public License +along with this program; if not, write to the Free Software Foundation, +Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. +

    +

    +@author Levi Bard <taktaktaktaktaktaktaktaktaktak@gmail.com> +

    + +
    + +
    +

    Required files

    + +
    + mkmf   +
    +
    + +
    + + +
    + + + + +
    + + +
    +

    Constants

    + +
    + + + + + + +
    ExtensionName='lightmediascanner'
    +
    +
    + + + + + + + + + +
    + + +
    +

    [Validate]

    +
    + + + \ No newline at end of file diff --git a/www/ruby-api/files/lightmediascanner-unittest_rb.html b/www/ruby-api/files/lightmediascanner-unittest_rb.html new file mode 100644 index 0000000..77e90f8 --- /dev/null +++ b/www/ruby-api/files/lightmediascanner-unittest_rb.html @@ -0,0 +1,135 @@ + + + + + + File: lightmediascanner-unittest.rb + + + + + + + + + + +
    +

    lightmediascanner-unittest.rb

    + + + + + + + + + +
    Path:lightmediascanner-unittest.rb +
    Last Update:Wed Jan 02 12:51:16 -0500 2008
    +
    + + +
    + + + +
    + +
    +

    +Copyright (C) 2007 by Levi Bard +

    +

    +This program is free software; you can redistribute it and/or modify it +under the terms of the GNU Lesser General Public License as published by +the Free Software Foundation; either version 2 of the License, or (at your +option) any later version. +

    +

    +This program is distributed in the hope that it will be useful, but WITHOUT +ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for +more details. +

    +

    +You should have received a copy of the GNU Lesser General Public License +along with this program; if not, write to the Free Software Foundation, +Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. +

    +

    +@author Levi Bard <taktaktaktaktaktaktaktaktaktak@gmail.com> +

    + +
    + +
    +

    Required files

    + +
    + lightmediascanner   + test/unit   +
    +
    + +
    + + +
    + + + + +
    + + + + + + + + + + + +
    + + +
    +

    [Validate]

    +
    + + + \ No newline at end of file diff --git a/www/ruby-api/files/lightmediascanner_parser_c.html b/www/ruby-api/files/lightmediascanner_parser_c.html new file mode 100644 index 0000000..5f5e32f --- /dev/null +++ b/www/ruby-api/files/lightmediascanner_parser_c.html @@ -0,0 +1,101 @@ + + + + + + File: lightmediascanner_parser.c + + + + + + + + + + +
    +

    lightmediascanner_parser.c

    + + + + + + + + + +
    Path:lightmediascanner_parser.c +
    Last Update:Thu Jan 03 07:31:10 -0500 2008
    +
    + + +
    + + + +
    + + + +
    + + +
    + + + + +
    + + + + + + + + + + + +
    + + +
    +

    [Validate]

    +
    + + + \ No newline at end of file diff --git a/www/ruby-api/files/lightmediascanner_parser_h.html b/www/ruby-api/files/lightmediascanner_parser_h.html new file mode 100644 index 0000000..d891dad --- /dev/null +++ b/www/ruby-api/files/lightmediascanner_parser_h.html @@ -0,0 +1,101 @@ + + + + + + File: lightmediascanner_parser.h + + + + + + + + + + +
    +

    lightmediascanner_parser.h

    + + + + + + + + + +
    Path:lightmediascanner_parser.h +
    Last Update:Wed Jan 02 10:53:50 -0500 2008
    +
    + + +
    + + + +
    + + + +
    + + +
    + + + + +
    + + + + + + + + + + + +
    + + +
    +

    [Validate]

    +
    + + + \ No newline at end of file diff --git a/www/ruby-api/files/lightmediascanner_scanner_c.html b/www/ruby-api/files/lightmediascanner_scanner_c.html new file mode 100644 index 0000000..68bd004 --- /dev/null +++ b/www/ruby-api/files/lightmediascanner_scanner_c.html @@ -0,0 +1,101 @@ + + + + + + File: lightmediascanner_scanner.c + + + + + + + + + + +
    +

    lightmediascanner_scanner.c

    + + + + + + + + + +
    Path:lightmediascanner_scanner.c +
    Last Update:Thu Jan 03 07:31:57 -0500 2008
    +
    + + +
    + + + +
    + + + +
    + + +
    + + + + +
    + + + + + + + + + + + +
    + + +
    +

    [Validate]

    +
    + + + \ No newline at end of file diff --git a/www/ruby-api/files/lightmediascanner_scanner_h.html b/www/ruby-api/files/lightmediascanner_scanner_h.html new file mode 100644 index 0000000..5006f11 --- /dev/null +++ b/www/ruby-api/files/lightmediascanner_scanner_h.html @@ -0,0 +1,101 @@ + + + + + + File: lightmediascanner_scanner.h + + + + + + + + + + +
    +

    lightmediascanner_scanner.h

    + + + + + + + + + +
    Path:lightmediascanner_scanner.h +
    Last Update:Wed Jan 02 12:22:26 -0500 2008
    +
    + + +
    + + + +
    + + + +
    + + +
    + + + + +
    + + + + + + + + + + + +
    + + +
    +

    [Validate]

    +
    + + + \ No newline at end of file diff --git a/www/ruby-api/files/rdoc_c.html b/www/ruby-api/files/rdoc_c.html new file mode 100644 index 0000000..bca1e34 --- /dev/null +++ b/www/ruby-api/files/rdoc_c.html @@ -0,0 +1,101 @@ + + + + + + File: rdoc.c + + + + + + + + + + +
    +

    rdoc.c

    + + + + + + + + + +
    Path:rdoc.c +
    Last Update:Thu Jan 03 07:32:05 -0500 2008
    +
    + + +
    + + + +
    + + + +
    + + +
    + + + + +
    + + + + + + + + + + + +
    + + +
    +

    [Validate]

    +
    + + + \ No newline at end of file diff --git a/www/ruby-api/files/ruby-lightmediascanner_c.html b/www/ruby-api/files/ruby-lightmediascanner_c.html new file mode 100644 index 0000000..7dae116 --- /dev/null +++ b/www/ruby-api/files/ruby-lightmediascanner_c.html @@ -0,0 +1,101 @@ + + + + + + File: ruby-lightmediascanner.c + + + + + + + + + + +
    +

    ruby-lightmediascanner.c

    + + + + + + + + + +
    Path:ruby-lightmediascanner.c +
    Last Update:Wed Jan 02 12:49:32 -0500 2008
    +
    + + +
    + + + +
    + + + +
    + + +
    + + + + +
    + + + + + + + + + + + +
    + + +
    +

    [Validate]

    +
    + + + \ No newline at end of file diff --git a/www/ruby-api/files/ruby-lightmediascanner_h.html b/www/ruby-api/files/ruby-lightmediascanner_h.html new file mode 100644 index 0000000..8db0a32 --- /dev/null +++ b/www/ruby-api/files/ruby-lightmediascanner_h.html @@ -0,0 +1,101 @@ + + + + + + File: ruby-lightmediascanner.h + + + + + + + + + + +
    +

    ruby-lightmediascanner.h

    + + + + + + + + + +
    Path:ruby-lightmediascanner.h +
    Last Update:Wed Jan 02 10:53:35 -0500 2008
    +
    + + +
    + + + +
    + + + +
    + + +
    + + + + +
    + + + + + + + + + + + +
    + + +
    +

    [Validate]

    +
    + + + \ No newline at end of file diff --git a/www/ruby-api/fr_class_index.html b/www/ruby-api/fr_class_index.html new file mode 100644 index 0000000..492f7a4 --- /dev/null +++ b/www/ruby-api/fr_class_index.html @@ -0,0 +1,30 @@ + + + + + + + + Classes + + + + + +
    +

    Classes

    + +
    + + \ No newline at end of file diff --git a/www/ruby-api/fr_file_index.html b/www/ruby-api/fr_file_index.html new file mode 100644 index 0000000..9fb65be --- /dev/null +++ b/www/ruby-api/fr_file_index.html @@ -0,0 +1,36 @@ + + + + + + + + Files + + + + + +
    +

    Files

    + +
    + + \ No newline at end of file diff --git a/www/ruby-api/fr_method_index.html b/www/ruby-api/fr_method_index.html new file mode 100644 index 0000000..f526b56 --- /dev/null +++ b/www/ruby-api/fr_method_index.html @@ -0,0 +1,41 @@ + + + + + + + + Methods + + + + + +
    +

    Methods

    + +
    + + \ No newline at end of file diff --git a/www/ruby-api/index.html b/www/ruby-api/index.html new file mode 100644 index 0000000..ea8e6e6 --- /dev/null +++ b/www/ruby-api/index.html @@ -0,0 +1,24 @@ + + + + + + + RDoc Documentation + + + + + + + + + + + \ No newline at end of file diff --git a/www/ruby-api/rdoc-style.css b/www/ruby-api/rdoc-style.css new file mode 100644 index 0000000..44c7b3d --- /dev/null +++ b/www/ruby-api/rdoc-style.css @@ -0,0 +1,208 @@ + +body { + font-family: Verdana,Arial,Helvetica,sans-serif; + font-size: 90%; + margin: 0; + margin-left: 40px; + padding: 0; + background: white; +} + +h1,h2,h3,h4 { margin: 0; color: #efefef; background: transparent; } +h1 { font-size: 150%; } +h2,h3,h4 { margin-top: 1em; } + +a { background: #eef; color: #039; text-decoration: none; } +a:hover { background: #039; color: #eef; } + +/* Override the base stylesheet's Anchor inside a table cell */ +td > a { + background: transparent; + color: #039; + text-decoration: none; +} + +/* and inside a section title */ +.section-title > a { + background: transparent; + color: #eee; + text-decoration: none; +} + +/* === Structural elements =================================== */ + +div#index { + margin: 0; + margin-left: -40px; + padding: 0; + font-size: 90%; +} + + +div#index a { + margin-left: 0.7em; +} + +div#index .section-bar { + margin-left: 0px; + padding-left: 0.7em; + background: #ccc; + font-size: small; +} + + +div#classHeader, div#fileHeader { + width: auto; + color: white; + padding: 0.5em 1.5em 0.5em 1.5em; + margin: 0; + margin-left: -40px; + border-bottom: 3px solid #006; +} + +div#classHeader a, div#fileHeader a { + background: inherit; + color: white; +} + +div#classHeader td, div#fileHeader td { + background: inherit; + color: white; +} + + +div#fileHeader { + background: #057; +} + +div#classHeader { + background: #048; +} + + +.class-name-in-header { + font-size: 180%; + font-weight: bold; +} + + +div#bodyContent { + padding: 0 1.5em 0 1.5em; +} + +div#description { + padding: 0.5em 1.5em; + background: #efefef; + border: 1px dotted #999; +} + +div#description h1,h2,h3,h4,h5,h6 { + color: #125;; + background: transparent; +} + +div#validator-badges { + text-align: center; +} +div#validator-badges img { border: 0; } + +div#copyright { + color: #333; + background: #efefef; + font: 0.75em sans-serif; + margin-top: 5em; + margin-bottom: 0; + padding: 0.5em 2em; +} + + +/* === Classes =================================== */ + +table.header-table { + color: white; + font-size: small; +} + +.type-note { + font-size: small; + color: #DEDEDE; +} + +.xxsection-bar { + background: #eee; + color: #333; + padding: 3px; +} + +.section-bar { + color: #333; + border-bottom: 1px solid #999; + margin-left: -20px; +} + + +.section-title { + background: #79a; + color: #eee; + padding: 3px; + margin-top: 2em; + margin-left: -30px; + border: 1px solid #999; +} + +.top-aligned-row { vertical-align: top } +.bottom-aligned-row { vertical-align: bottom } + +/* --- Context section classes ----------------------- */ + +.context-row { } +.context-item-name { font-family: monospace; font-weight: bold; color: black; } +.context-item-value { font-size: small; color: #448; } +.context-item-desc { color: #333; padding-left: 2em; } + +/* --- Method classes -------------------------- */ +.method-detail { + background: #efefef; + padding: 0; + margin-top: 0.5em; + margin-bottom: 1em; + border: 1px dotted #ccc; +} +.method-heading { + color: black; + background: #ccc; + border-bottom: 1px solid #666; + padding: 0.2em 0.5em 0 0.5em; +} +.method-signature { color: black; background: inherit; } +.method-name { font-weight: bold; } +.method-args { font-style: italic; } +.method-description { padding: 0 0.5em 0 0.5em; } + +/* --- Source code sections -------------------- */ + +a.source-toggle { font-size: 90%; } +div.method-source-code { + background: #262626; + color: #ffdead; + margin: 1em; + padding: 0.5em; + border: 1px dashed #999; + overflow: hidden; +} + +div.method-source-code pre { color: #ffdead; overflow: hidden; } + +/* --- Ruby keyword styles --------------------- */ + +.standalone-code { background: #221111; color: #ffdead; overflow: hidden; } + +.ruby-constant { color: #7fffd4; background: transparent; } +.ruby-keyword { color: #00ffff; background: transparent; } +.ruby-ivar { color: #eedd82; background: transparent; } +.ruby-operator { color: #00ffee; background: transparent; } +.ruby-identifier { color: #ffdead; background: transparent; } +.ruby-node { color: #ffa07a; background: transparent; } +.ruby-comment { color: #b22222; font-weight: bold; background: transparent; } +.ruby-regexp { color: #ffa07a; background: transparent; } +.ruby-value { color: #7fffd4; background: transparent; } \ No newline at end of file