From 236dab5626351a96d3f8c2e992836e5835e4590c Mon Sep 17 00:00:00 2001 From: Victor Häggqvist Date: Thu, 17 Sep 2015 17:43:37 +0200 Subject: Update JavaDoc --- com/snilius/aboutit/AboutIt.html | 543 +++++++++++++++++++++++++++++++ com/snilius/aboutit/CustomLicense.html | 287 ++++++++++++++++ com/snilius/aboutit/L.html | 437 +++++++++++++++++++++++++ com/snilius/aboutit/LibBuilder.html | 324 ++++++++++++++++++ com/snilius/aboutit/LibSkeleton.html | 244 ++++++++++++++ com/snilius/aboutit/LicenseBase.html | 233 +++++++++++++ com/snilius/aboutit/package-frame.html | 31 ++ com/snilius/aboutit/package-summary.html | 192 +++++++++++ com/snilius/aboutit/package-tree.html | 148 +++++++++ 9 files changed, 2439 insertions(+) create mode 100644 com/snilius/aboutit/AboutIt.html create mode 100644 com/snilius/aboutit/CustomLicense.html create mode 100644 com/snilius/aboutit/L.html create mode 100644 com/snilius/aboutit/LibBuilder.html create mode 100644 com/snilius/aboutit/LibSkeleton.html create mode 100644 com/snilius/aboutit/LicenseBase.html create mode 100644 com/snilius/aboutit/package-frame.html create mode 100644 com/snilius/aboutit/package-summary.html create mode 100644 com/snilius/aboutit/package-tree.html (limited to 'com/snilius/aboutit') diff --git a/com/snilius/aboutit/AboutIt.html b/com/snilius/aboutit/AboutIt.html new file mode 100644 index 0000000..7db57e3 --- /dev/null +++ b/com/snilius/aboutit/AboutIt.html @@ -0,0 +1,543 @@ + + + + + +AboutIt (AboutIt) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.snilius.aboutit
+

Class AboutIt

+
+
+ +
+
    +
  • +
    +
    +
    public class AboutIt
+extends Object
    +

    AboutIt

    + A About-page creator + + 
    + 
+ new AboutIt(this).app(R.string.app_name)
+     .buildInfo(BuildConfig.DEBUG, BuildConfig.VERSION_CODE, BuildConfig.VERSION_NAME)
+     .copyright("Example Business")
+     .libLicense("AboutIt", "Victor Häggqvist", L.AP2, "https://github.com/victorhaggqvist/aboutit")
+     .toTextView(R.id.about_text);
+ 
+
    +
    +
    Since:
    +
    12/29/14
    +
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        AboutIt

        +
        public AboutIt(Activity activity)
        +
        Create a page generator
        +
        +
        Parameters:
        +
        activity - The about page activity
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        toTextView

        +
        public void toTextView(@IdRes
+                       int about_text)
        +
        Generate text and put in @ref{about_text}
        +
        +
        Parameters:
        +
        about_text - Resource it of destination TextView
        +
        +
        • +
      + + + +
        +
      • +

        getVersionString

        +
        public String getVersionString()
        +
        Get a baked version string. + Version string is build from build info and release name + It will look something like '1.42 (42-debug)'
        +
        +
        Returns:
        +
        baked version string
        +
        +
        • +
      + + + +
        +
      • +

        copyright

        +
        public AboutIt copyright(String copyright)
        +
        Copyright name
        +
        +
        Parameters:
        +
        copyright - Name
        +
        +
        • +
      + + + +
        +
      • +

        year

        +
        public AboutIt year(int year)
        +
        Start copyright year. + If there is no start year no year will be displayed at all.
        +
        +
        Parameters:
        +
        year - Year
        +
        +
        • +
      + + + +
        +
      • +

        libLicense

        +
        public AboutIt libLicense(String name,
+                          String author,
+                          L license,
+                          String url)
        +
        Add a library to the list
        +
        +
        Parameters:
        +
        name - Name of Library
        +
        author - Author of library
        +
        license - Library license, defined by L
        +
        url - Url to or otherwise reference to library
        +
        See Also:
        +
        L
        +
        +
        • +
      + + + +
        +
      • +

        libLicense

        +
        public AboutIt libLicense(com.snilius.aboutit.AboutIt.Lib library)
        +
        Add a library to the list
        +
        +
        Parameters:
        +
        library - A library build with LibBuilder
        +
        +
        • +
      + + + +
        +
      • +

        app

        +
        public AboutIt app(@StringRes
+                   int stringResource)
        +
        App name to display
        +
        +
        Parameters:
        +
        stringResource - A string resource id
        +
        +
        • +
      + + + + + + + +
        +
      • +

        release

        +
        public AboutIt release(String releaseName)
        +
        Set a custom release name. Override the default name eg. beta
        +
        +
        Parameters:
        +
        releaseName - The release name
        +
        +
        • +
      + + + +
        +
      • +

        buildInfo

        +
        public AboutIt buildInfo(boolean debug,
+                         int versionCode,
+                         String versionName)
        +
        App build info. To be used in conjunction with the BuildConfig class + .buildInfo(BuildConfig.DEBUG, BuildConfig.VERSION_CODE, BuildConfig.VERSION_NAME)
        +
        +
        Parameters:
        +
        debug - If is debug build
        +
        versionCode - Version code
        +
        versionName - Version name
        +
        +
        • +
      + + + +
        +
      • +

        description

        +
        public AboutIt description(@StringRes
+                           int stringResource)
        +
        A longer description
        +
        +
        Parameters:
        +
        stringResource - A string resource id
        +
        +
        • +
      + + + +
        +
      • +

        description

        +
        public AboutIt description(String description)
        +
        A longer description
        +
        +
        Parameters:
        +
        description - The description
        +
        See Also:
        +
        description(int)
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/com/snilius/aboutit/CustomLicense.html b/com/snilius/aboutit/CustomLicense.html new file mode 100644 index 0000000..47afaec --- /dev/null +++ b/com/snilius/aboutit/CustomLicense.html @@ -0,0 +1,287 @@ + + + + + +CustomLicense (AboutIt) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.snilius.aboutit
+

Class CustomLicense

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    LicenseBase
    +
    +
    +
    +
    public class CustomLicense
+extends Object
+implements LicenseBase
    +
    Custom license holder
    +
    +
    Since:
    +
    9/17/15
    +
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        CustomLicense

        +
        public CustomLicense(String displayName)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        display

        +
        public String display()
        +
        Description copied from interface: LicenseBase
        +
        Get display name for license
        +
        +
        Specified by:
        +
        display in interface LicenseBase
        +
        Returns:
        +
        display name
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/com/snilius/aboutit/L.html b/com/snilius/aboutit/L.html new file mode 100644 index 0000000..4892b39 --- /dev/null +++ b/com/snilius/aboutit/L.html @@ -0,0 +1,437 @@ + + + + + +L (AboutIt) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.snilius.aboutit
+

Enum L

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Enum Constant Detail

      + + + +
        +
      • +

        AP2

        +
        public static final L AP2
        +
        • +
      + + + +
        +
      • +

        MIT

        +
        public static final L MIT
        +
        • +
      + + + +
        +
      • +

        GPL2

        +
        public static final L GPL2
        +
        • +
      + + + +
        +
      • +

        GPL3

        +
        public static final L GPL3
        +
        • +
      + + + +
        +
      • +

        AGPL3

        +
        public static final L AGPL3
        +
        • +
      + + + +
        +
      • +

        BSD

        +
        public static final L BSD
        +
        • +
      + + + +
        +
      • +

        SBSD

        +
        public static final L SBSD
        +
        • +
      + + + +
        +
      • +

        NBSD

        +
        public static final L NBSD
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static L[] values()
        +
        Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
        +for (L c : L.values())
+    System.out.println(c);
+
        +
        +
        Returns:
        +
        an array containing the constants of this enum type, in the order they are declared
        +
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static L valueOf(String name)
        +
        Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
        +
        +
        Parameters:
        +
        name - the name of the enum constant to be returned.
        +
        Returns:
        +
        the enum constant with the specified name
        +
        Throws:
        +
        IllegalArgumentException - if this enum type has no constant with the specified name
        +
        NullPointerException - if the argument is null
        +
        +
        • +
      + + + +
        +
      • +

        display

        +
        public String display()
        +
        Get display name for license
        +
        +
        Specified by:
        +
        display in interface LicenseBase
        +
        Returns:
        +
        display name
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/com/snilius/aboutit/LibBuilder.html b/com/snilius/aboutit/LibBuilder.html new file mode 100644 index 0000000..d3f8036 --- /dev/null +++ b/com/snilius/aboutit/LibBuilder.html @@ -0,0 +1,324 @@ + + + + + +LibBuilder (AboutIt) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.snilius.aboutit
+

Class LibBuilder

+
+
+ +
+
    +
  • +
    +
    +
    public class LibBuilder
+extends Object
    +
    Library builder
    +
    +
    Since:
    +
    9/17/15
    +
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/com/snilius/aboutit/LibSkeleton.html b/com/snilius/aboutit/LibSkeleton.html new file mode 100644 index 0000000..efa69cf --- /dev/null +++ b/com/snilius/aboutit/LibSkeleton.html @@ -0,0 +1,244 @@ + + + + + +LibSkeleton (AboutIt) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.snilius.aboutit
+

Class LibSkeleton

+
+
+ +
+
    +
  • +
    +
    +
    public class LibSkeleton
+extends Object
    +
    Library skeleton for creation of presets
    +
    +
    Since:
    +
    9/17/15
    +
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/com/snilius/aboutit/LicenseBase.html b/com/snilius/aboutit/LicenseBase.html new file mode 100644 index 0000000..db99002 --- /dev/null +++ b/com/snilius/aboutit/LicenseBase.html @@ -0,0 +1,233 @@ + + + + + +LicenseBase (AboutIt) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.snilius.aboutit
+

Interface LicenseBase

+
+
+
+
    +
  • +
    +
    All Known Implementing Classes:
    +
    CustomLicense, L
    +
    +
    +
    +
    public interface LicenseBase
    +
    License base
    +
    +
    Since:
    +
    9/17/15
    +
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        display

        +
        String display()
        +
        Get display name for license
        +
        +
        Returns:
        +
        display name
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/com/snilius/aboutit/package-frame.html b/com/snilius/aboutit/package-frame.html new file mode 100644 index 0000000..2a00586 --- /dev/null +++ b/com/snilius/aboutit/package-frame.html @@ -0,0 +1,31 @@ + + + + + +com.snilius.aboutit (AboutIt) + + + + + +

com.snilius.aboutit

+
+

Interfaces

+ +

Classes

+ +

Enums

+ +
+ + diff --git a/com/snilius/aboutit/package-summary.html b/com/snilius/aboutit/package-summary.html new file mode 100644 index 0000000..9f6a239 --- /dev/null +++ b/com/snilius/aboutit/package-summary.html @@ -0,0 +1,192 @@ + + + + + +com.snilius.aboutit (AboutIt) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package com.snilius.aboutit

+
+
+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/com/snilius/aboutit/package-tree.html b/com/snilius/aboutit/package-tree.html new file mode 100644 index 0000000..9306cd2 --- /dev/null +++ b/com/snilius/aboutit/package-tree.html @@ -0,0 +1,148 @@ + + + + + +com.snilius.aboutit Class Hierarchy (AboutIt) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package com.snilius.aboutit

+
+
+

Class Hierarchy

+ +

Interface Hierarchy

+ +

Enum Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + -- cgit v1.2.3