Skip to content

Commit

Permalink
Add javadoc for 4.2
Browse files Browse the repository at this point in the history
  • Loading branch information
@bsteffensmeier
bsteffensmeier committed Dec 16, 2023
1 parent 1f41087 commit b75ba00
Show file tree
Hide file tree
Showing 70 changed files with 36,821 additions and 7 deletions.
6 changes: 3 additions & 3 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
Jep - Java Embedded Python
===========================

[![Python: 3.5, 3.6, 3.7, 3.8, 3.9, 3.10, 3.11](https://img.shields.io/pypi/pyversions/Jep.svg)](https://pypi.org/pypi/jep)
[![Python: 3.6, 3.7, 3.8, 3.9, 3.10, 3.11, 3.12](https://img.shields.io/pypi/pyversions/Jep.svg)](https://pypi.org/pypi/jep)
[![License: zlib/libpng](https://img.shields.io/pypi/l/Jep.svg)](https://pypi.org/pypi/jep)
[![Pypi: v4.1.0](https://img.shields.io/pypi/v/Jep.svg)](https://pypi.org/pypi/jep)
[![Pypi: v4.2.0](https://img.shields.io/pypi/v/Jep.svg)](https://pypi.org/pypi/jep)
[![Docs: wiki](https://img.shields.io/badge/docs-wiki-orange.svg)](https://github.com/ninia/jep/wiki)
[![Docs: JavaDoc](https://img.shields.io/badge/docs-javadoc-orange.svg)](javadoc)

Expand Down Expand Up @@ -35,7 +35,7 @@ Building and installing require the JDK, Python, and optionally numpy to be inst

Dependencies
------------
* Python >= 3.5
* Python >= 3.6
* Java >= 1.8
* NumPy >= 1.7 (optional)

Expand Down
40 changes: 40 additions & 0 deletions javadoc/4.2/allclasses-frame.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>All Classes</title>
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<script type="text/javascript" src="script.js"></script>
</head>
<body>
<h1 class="bar">All&nbsp;Classes</h1>
<div class="indexContainer">
<ul>
<li><a href="jep/ClassEnquirer.html" title="interface in jep" target="classFrame"><span class="interfaceName">ClassEnquirer</span></a></li>
<li><a href="jep/ClassList.html" title="class in jep" target="classFrame">ClassList</a></li>
<li><a href="jep/DirectNDArray.html" title="class in jep" target="classFrame">DirectNDArray</a></li>
<li><a href="jep/Interpreter.html" title="interface in jep" target="classFrame"><span class="interfaceName">Interpreter</span></a></li>
<li><a href="jep/python/InvocationHandler.html" title="class in jep.python" target="classFrame">InvocationHandler</a></li>
<li><a href="jep/Jep.html" title="class in jep" target="classFrame">Jep</a></li>
<li><a href="jep/JepAccess.html" title="class in jep" target="classFrame">JepAccess</a></li>
<li><a href="jep/JepConfig.html" title="class in jep" target="classFrame">JepConfig</a></li>
<li><a href="jep/JepException.html" title="class in jep" target="classFrame">JepException</a></li>
<li><a href="jep/MainInterpreter.html" title="class in jep" target="classFrame">MainInterpreter</a></li>
<li><a href="jep/python/MemoryManager.html" title="class in jep.python" target="classFrame">MemoryManager</a></li>
<li><a href="jep/NamingConventionClassEnquirer.html" title="class in jep" target="classFrame">NamingConventionClassEnquirer</a></li>
<li><a href="jep/NDArray.html" title="class in jep" target="classFrame">NDArray</a></li>
<li><a href="jep/python/PyBuiltins.html" title="interface in jep.python" target="classFrame"><span class="interfaceName">PyBuiltins</span></a></li>
<li><a href="jep/python/PyCallable.html" title="class in jep.python" target="classFrame">PyCallable</a></li>
<li><a href="jep/PyConfig.html" title="class in jep" target="classFrame">PyConfig</a></li>
<li><a href="jep/PyMethod.html" title="annotation in jep" target="classFrame">PyMethod</a></li>
<li><a href="jep/python/PyObject.html" title="class in jep.python" target="classFrame">PyObject</a></li>
<li><a href="jep/python/PyPointer.html" title="class in jep.python" target="classFrame">PyPointer</a></li>
<li><a href="jep/Run.html" title="class in jep" target="classFrame">Run</a></li>
<li><a href="jep/SharedInterpreter.html" title="class in jep" target="classFrame">SharedInterpreter</a></li>
<li><a href="jep/SubInterpreter.html" title="class in jep" target="classFrame">SubInterpreter</a></li>
<li><a href="jep/SubInterpreterOptions.html" title="class in jep" target="classFrame">SubInterpreterOptions</a></li>
</ul>
</div>
</body>
</html>
304 changes: 304 additions & 0 deletions javadoc/4.2/allclasses-index.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,304 @@
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>All Classes</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="jquery/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="script.js"></script>
<script type="text/javascript" src="jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="jquery/jquery-3.6.0.min.js"></script>
<script type="text/javascript" src="jquery/jquery-ui.min.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="All Classes";
}
}
catch(err) {
}
//-->
var data = {"i0":1,"i1":2,"i2":2,"i3":1,"i4":2,"i5":2,"i6":2,"i7":2,"i8":8,"i9":2,"i10":2,"i11":2,"i12":2,"i13":1,"i14":2,"i15":2,"i16":2,"i17":2,"i18":2,"i19":2,"i20":2};
var tabs = {65535:["t0","All Classes"],1:["t1","Interface Summary"],2:["t2","Class Summary"],8:["t4","Exception Summary"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "./";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="index.html">Overview</a></li>
<li>Package</li>
<li>Class</li>
<li><a href="overview-tree.html">Tree</a></li>
<li><a href="deprecated-list.html">Deprecated</a></li>
<li><a href="index-all.html">Index</a></li>
<li><a href="help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<main role="main">
<div class="header">
<h1 title="All&amp;nbsp;Classes" class="title">All&nbsp;Classes</h1>
</div>
<div class="allClassesContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary">
<caption><span id="t0" class="activeTableTab"><span>All Classes</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Interface Summary</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Class Summary</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Exception Summary</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><a href="jep/ClassEnquirer.html" title="interface in jep">ClassEnquirer</a></td>
<th class="colLast" scope="row">
<div class="block">Interface to enquire if a name is available to be imported from Java.</div>
</th>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><a href="jep/ClassList.html" title="class in jep">ClassList</a></td>
<th class="colLast" scope="row">
<div class="block">A singleton that searches for loaded classes from the JRE and the Java
classpath.</div>
</th>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><a href="jep/DirectNDArray.html" title="class in jep">DirectNDArray</a>&lt;<a href="jep/DirectNDArray.html" title="type parameter in DirectNDArray">T</a> extends java.nio.Buffer&gt;</td>
<th class="colLast" scope="row">
<div class="block">
Represents a <a href="http://docs.scipy.org/doc/numpy/reference/generated/numpy.ndarray.html">numpy.ndarray</a> in Java.</div>
</th>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><a href="jep/Interpreter.html" title="interface in jep">Interpreter</a></td>
<th class="colLast" scope="row">
<div class="block">An interface for using a Python Interpreter.</div>
</th>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><a href="jep/python/InvocationHandler.html" title="class in jep.python">InvocationHandler</a></td>
<th class="colLast" scope="row">
<div class="block">Handle Proxy method calls.</div>
</th>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><a href="jep/Jep.html" title="class in jep">Jep</a></td>
<th class="colLast" scope="row">
<div class="block">As of Jep 3.9, you should strive to instantiate either a SubInterpreter or a
SharedInterpreter instance and for interacting with the interpreter use the
interface Interpreter.</div>
</th>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><a href="jep/JepAccess.html" title="class in jep">JepAccess</a></td>
<th class="colLast" scope="row">
<div class="block">
Allow access to Jep internal structure in sub-packages.</div>
</th>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><a href="jep/JepConfig.html" title="class in jep">JepConfig</a></td>
<th class="colLast" scope="row">
<div class="block">
A configuration object for constructing a Jep instance, corresponding to the
configuration of the particular Python sub-interpreter.</div>
</th>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><a href="jep/JepException.html" title="class in jep">JepException</a></td>
<th class="colLast" scope="row">
<div class="block">JepException - it happens.</div>
</th>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><a href="jep/MainInterpreter.html" title="class in jep">MainInterpreter</a></td>
<th class="colLast" scope="row">
<div class="block">The main Python interpreter that all sub-interpreters will be created from.</div>
</th>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><a href="jep/python/MemoryManager.html" title="class in jep.python">MemoryManager</a></td>
<th class="colLast" scope="row">
<div class="block">Manages the native memory associated with PyObjects in an Interpreter.</div>
</th>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><a href="jep/NamingConventionClassEnquirer.html" title="class in jep">NamingConventionClassEnquirer</a></td>
<th class="colLast" scope="row">
<div class="block">
A simple <a href="jep/ClassEnquirer.html" title="interface in jep"><code>ClassEnquirer</code></a> to see if the package/class to be imported in
a Python interpreter should be considered as a Java package/class.</div>
</th>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><a href="jep/NDArray.html" title="class in jep">NDArray</a>&lt;<a href="jep/NDArray.html" title="type parameter in NDArray">T</a>&gt;</td>
<th class="colLast" scope="row">
<div class="block">
Represents a <a href="http://docs.scipy.org/doc/numpy/reference/generated/numpy.ndarray.html">numpy.ndarray</a> in Java.</div>
</th>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><a href="jep/python/PyBuiltins.html" title="interface in jep.python">PyBuiltins</a></td>
<th class="colLast" scope="row">
<div class="block">Interface for accessing some of the functions of the Python builtins module from Java.</div>
</th>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><a href="jep/python/PyCallable.html" title="class in jep.python">PyCallable</a></td>
<th class="colLast" scope="row">
<div class="block">A Java object that wraps a pointer to a Python callable.</div>
</th>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><a href="jep/PyConfig.html" title="class in jep">PyConfig</a></td>
<th class="colLast" scope="row">
<div class="block">
A configuration object for setting Python pre-initialization parameters.</div>
</th>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><a href="jep/python/PyObject.html" title="class in jep.python">PyObject</a></td>
<th class="colLast" scope="row">
<div class="block">A Java object that wraps a pointer to a Python object.</div>
</th>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><a href="jep/python/PyPointer.html" title="class in jep.python">PyPointer</a></td>
<th class="colLast" scope="row">
<div class="block">Contains pointers to a JepThread* and a PyObject* for using a PyObject* in
Java as a PyObject or its subclasses.</div>
</th>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><a href="jep/Run.html" title="class in jep">Run</a></td>
<th class="colLast" scope="row">
<div class="block">Executes a Python script in a Jep Interpreter.</div>
</th>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><a href="jep/SharedInterpreter.html" title="class in jep">SharedInterpreter</a></td>
<th class="colLast" scope="row">
<div class="block">Class for creating instances of Interpreters which share all imported
modules.</div>
</th>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><a href="jep/SubInterpreter.html" title="class in jep">SubInterpreter</a></td>
<th class="colLast" scope="row">
<div class="block">Class for creating instances of Interpreters which are sandboxed from other
Interpreters.</div>
</th>
</tr>
</table>
</li>
</ul>
</div>
</main>
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="index.html">Overview</a></li>
<li>Package</li>
<li>Class</li>
<li><a href="overview-tree.html">Tree</a></li>
<li><a href="deprecated-list.html">Deprecated</a></li>
<li><a href="index-all.html">Index</a></li>
<li><a href="help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="allclasses.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
</footer>
</body>
</html>
Loading

0 comments on commit b75ba00

Please sign in to comment.