diff options
author | Victor Häggqvist <[email protected]> | 2018-07-26 23:36:30 +0200 |
---|---|---|
committer | Victor Häggqvist <[email protected]> | 2018-07-26 23:36:30 +0200 |
commit | a7f7b0028cbd28e1b4cb954862a2da0270fbd63a (patch) | |
tree | b85ef64d62096b89dbc073a8c1fd9c31edd254dc /com/snilius/aboutit/AboutIt.html | |
parent | 236dab5626351a96d3f8c2e992836e5835e4590c (diff) |
Update JavaDoc
Diffstat (limited to '')
-rw-r--r-- | com/snilius/aboutit/AboutIt.html | 65 |
1 files changed, 31 insertions, 34 deletions
diff --git a/com/snilius/aboutit/AboutIt.html b/com/snilius/aboutit/AboutIt.html index 7db57e3..5882519 100644 --- a/com/snilius/aboutit/AboutIt.html +++ b/com/snilius/aboutit/AboutIt.html @@ -2,9 +2,9 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_60) on Thu Sep 17 17:33:20 CEST 2015 --> -<title>AboutIt (AboutIt)</title> -<meta name="date" content="2015-09-17"> +<!-- Generated by javadoc (1.8.0_172) on Thu Jul 26 23:34:39 CEST 2018 --> +<title>AboutIt (aboutit 1.2.3-SNAPSHOT API)</title> +<meta name="date" content="2018-07-26"> <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> <script type="text/javascript" src="../../../script.js"></script> </head> @@ -12,7 +12,7 @@ <script type="text/javascript"><!-- try { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="AboutIt (AboutIt)"; + parent.document.title="AboutIt (aboutit 1.2.3-SNAPSHOT API)"; } } catch(err) { @@ -95,7 +95,7 @@ var activeTableTab = "activeTableTab"; </div> <div class="contentContainer"> <ul class="inheritance"> -<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> +<li>java.lang.Object</li> <li> <ul class="inheritance"> <li>com.snilius.aboutit.AboutIt</li> @@ -108,7 +108,7 @@ var activeTableTab = "activeTableTab"; <hr> <br> <pre>public class <span class="typeNameLabel">AboutIt</span> -extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre> +extends java.lang.Object</pre> <div class="block"><h1>AboutIt</h1> A About-page creator @@ -143,7 +143,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <th class="colOne" scope="col">Constructor and Description</th> </tr> <tr class="altColor"> -<td class="colOne"><code><span class="memberNameLink"><a href="../../../com/snilius/aboutit/AboutIt.html#AboutIt-android.app.Activity-">AboutIt</a></span>(<a href="http://d.android.com/reference/android/app/Activity.html?is-external=true" title="class or interface in android.app">Activity</a> activity)</code> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../com/snilius/aboutit/AboutIt.html#AboutIt-android.app.Activity-">AboutIt</a></span>(android.app.Activity activity)</code> <div class="block">Create a page generator</div> </td> </tr> @@ -170,7 +170,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? </tr> <tr id="i1" class="rowColor"> <td class="colFirst"><code><a href="../../../com/snilius/aboutit/AboutIt.html" title="class in com.snilius.aboutit">AboutIt</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/snilius/aboutit/AboutIt.html#app-java.lang.String-">app</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> appName)</code> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/snilius/aboutit/AboutIt.html#app-java.lang.String-">app</a></span>(java.lang.String appName)</code> <div class="block">App name to display</div> </td> </tr> @@ -178,13 +178,13 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <td class="colFirst"><code><a href="../../../com/snilius/aboutit/AboutIt.html" title="class in com.snilius.aboutit">AboutIt</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/snilius/aboutit/AboutIt.html#buildInfo-boolean-int-java.lang.String-">buildInfo</a></span>(boolean debug, int versionCode, - <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> versionName)</code> + java.lang.String versionName)</code> <div class="block">App build info.</div> </td> </tr> <tr id="i3" class="rowColor"> <td class="colFirst"><code><a href="../../../com/snilius/aboutit/AboutIt.html" title="class in com.snilius.aboutit">AboutIt</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/snilius/aboutit/AboutIt.html#copyright-java.lang.String-">copyright</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> copyright)</code> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/snilius/aboutit/AboutIt.html#copyright-java.lang.String-">copyright</a></span>(java.lang.String copyright)</code> <div class="block">Copyright name</div> </td> </tr> @@ -196,12 +196,12 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? </tr> <tr id="i5" class="rowColor"> <td class="colFirst"><code><a href="../../../com/snilius/aboutit/AboutIt.html" title="class in com.snilius.aboutit">AboutIt</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/snilius/aboutit/AboutIt.html#description-java.lang.String-">description</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> description)</code> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/snilius/aboutit/AboutIt.html#description-java.lang.String-">description</a></span>(java.lang.String description)</code> <div class="block">A longer description</div> </td> </tr> <tr id="i6" class="altColor"> -<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> +<td class="colFirst"><code>java.lang.String</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/snilius/aboutit/AboutIt.html#getVersionString--">getVersionString</a></span>()</code> <div class="block">Get a baked version string.</div> </td> @@ -214,16 +214,16 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? </tr> <tr id="i8" class="altColor"> <td class="colFirst"><code><a href="../../../com/snilius/aboutit/AboutIt.html" title="class in com.snilius.aboutit">AboutIt</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/snilius/aboutit/AboutIt.html#libLicense-java.lang.String-java.lang.String-com.snilius.aboutit.L-java.lang.String-">libLicense</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, - <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> author, +<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/snilius/aboutit/AboutIt.html#libLicense-java.lang.String-java.lang.String-com.snilius.aboutit.L-java.lang.String-">libLicense</a></span>(java.lang.String name, + java.lang.String author, <a href="../../../com/snilius/aboutit/L.html" title="enum in com.snilius.aboutit">L</a> license, - <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> url)</code> + java.lang.String url)</code> <div class="block">Add a library to the list</div> </td> </tr> <tr id="i9" class="rowColor"> <td class="colFirst"><code><a href="../../../com/snilius/aboutit/AboutIt.html" title="class in com.snilius.aboutit">AboutIt</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/snilius/aboutit/AboutIt.html#release-java.lang.String-">release</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> releaseName)</code> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/snilius/aboutit/AboutIt.html#release-java.lang.String-">release</a></span>(java.lang.String releaseName)</code> <div class="block">Set a custom release name.</div> </td> </tr> @@ -244,8 +244,8 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> <!-- --> </a> -<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> -<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> +<h3>Methods inherited from class java.lang.Object</h3> +<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> </ul> </li> </ul> @@ -267,7 +267,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <ul class="blockListLast"> <li class="blockList"> <h4>AboutIt</h4> -<pre>public AboutIt(<a href="http://d.android.com/reference/android/app/Activity.html?is-external=true" title="class or interface in android.app">Activity</a> activity)</pre> +<pre>public AboutIt(android.app.Activity activity)</pre> <div class="block">Create a page generator</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> @@ -289,8 +289,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <ul class="blockList"> <li class="blockList"> <h4>toTextView</h4> -<pre>public void toTextView(<a href="http://d.android.com/reference/android/support/annotation/IdRes.html?is-external=true" title="class or interface in android.support.annotation">@IdRes</a> - int about_text)</pre> +<pre>public void toTextView(int about_text)</pre> <div class="block">Generate text and put in @ref{about_text}</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> @@ -304,7 +303,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <ul class="blockList"> <li class="blockList"> <h4>getVersionString</h4> -<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getVersionString()</pre> +<pre>public java.lang.String getVersionString()</pre> <div class="block">Get a baked version string. Version string is build from build info and release name It will look something like '1.42 (42-debug)'</div> @@ -320,7 +319,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <ul class="blockList"> <li class="blockList"> <h4>copyright</h4> -<pre>public <a href="../../../com/snilius/aboutit/AboutIt.html" title="class in com.snilius.aboutit">AboutIt</a> copyright(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> copyright)</pre> +<pre>public <a href="../../../com/snilius/aboutit/AboutIt.html" title="class in com.snilius.aboutit">AboutIt</a> copyright(java.lang.String copyright)</pre> <div class="block">Copyright name</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> @@ -349,10 +348,10 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <ul class="blockList"> <li class="blockList"> <h4>libLicense</h4> -<pre>public <a href="../../../com/snilius/aboutit/AboutIt.html" title="class in com.snilius.aboutit">AboutIt</a> libLicense(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, - <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> author, +<pre>public <a href="../../../com/snilius/aboutit/AboutIt.html" title="class in com.snilius.aboutit">AboutIt</a> libLicense(java.lang.String name, + java.lang.String author, <a href="../../../com/snilius/aboutit/L.html" title="enum in com.snilius.aboutit">L</a> license, - <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> url)</pre> + java.lang.String url)</pre> <div class="block">Add a library to the list</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> @@ -385,8 +384,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <ul class="blockList"> <li class="blockList"> <h4>app</h4> -<pre>public <a href="../../../com/snilius/aboutit/AboutIt.html" title="class in com.snilius.aboutit">AboutIt</a> app(<a href="http://d.android.com/reference/android/support/annotation/StringRes.html?is-external=true" title="class or interface in android.support.annotation">@StringRes</a> - int stringResource)</pre> +<pre>public <a href="../../../com/snilius/aboutit/AboutIt.html" title="class in com.snilius.aboutit">AboutIt</a> app(int stringResource)</pre> <div class="block">App name to display</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> @@ -400,7 +398,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <ul class="blockList"> <li class="blockList"> <h4>app</h4> -<pre>public <a href="../../../com/snilius/aboutit/AboutIt.html" title="class in com.snilius.aboutit">AboutIt</a> app(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> appName)</pre> +<pre>public <a href="../../../com/snilius/aboutit/AboutIt.html" title="class in com.snilius.aboutit">AboutIt</a> app(java.lang.String appName)</pre> <div class="block">App name to display</div> <dl> <dt><span class="seeLabel">See Also:</span></dt> @@ -414,7 +412,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <ul class="blockList"> <li class="blockList"> <h4>release</h4> -<pre>public <a href="../../../com/snilius/aboutit/AboutIt.html" title="class in com.snilius.aboutit">AboutIt</a> release(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> releaseName)</pre> +<pre>public <a href="../../../com/snilius/aboutit/AboutIt.html" title="class in com.snilius.aboutit">AboutIt</a> release(java.lang.String releaseName)</pre> <div class="block">Set a custom release name. Override the default name eg. beta</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> @@ -430,7 +428,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <h4>buildInfo</h4> <pre>public <a href="../../../com/snilius/aboutit/AboutIt.html" title="class in com.snilius.aboutit">AboutIt</a> buildInfo(boolean debug, int versionCode, - <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> versionName)</pre> + java.lang.String versionName)</pre> <div class="block">App build info. To be used in conjunction with the BuildConfig class <code>.buildInfo(BuildConfig.DEBUG, BuildConfig.VERSION_CODE, BuildConfig.VERSION_NAME)</code></div> <dl> @@ -447,8 +445,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <ul class="blockList"> <li class="blockList"> <h4>description</h4> -<pre>public <a href="../../../com/snilius/aboutit/AboutIt.html" title="class in com.snilius.aboutit">AboutIt</a> description(<a href="http://d.android.com/reference/android/support/annotation/StringRes.html?is-external=true" title="class or interface in android.support.annotation">@StringRes</a> - int stringResource)</pre> +<pre>public <a href="../../../com/snilius/aboutit/AboutIt.html" title="class in com.snilius.aboutit">AboutIt</a> description(int stringResource)</pre> <div class="block">A longer description</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> @@ -462,7 +459,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <ul class="blockListLast"> <li class="blockList"> <h4>description</h4> -<pre>public <a href="../../../com/snilius/aboutit/AboutIt.html" title="class in com.snilius.aboutit">AboutIt</a> description(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> description)</pre> +<pre>public <a href="../../../com/snilius/aboutit/AboutIt.html" title="class in com.snilius.aboutit">AboutIt</a> description(java.lang.String description)</pre> <div class="block">A longer description</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> |