Python doc generation from Java source
Nicolas Falliere <[email protected]> Wed, 21 Apr 2021 23:06:53 -0700
| Newsgroups | gmane.comp.lang.jython.user |
|---|---|
| Message-ID | <CAJP=iOVvmtw2CFG+xRjosgxK_qxYzudw2XCezsgNVmmbUHCgYQ@mail.gmail.com> |
--===============1295345966562316089== Content-Type: multipart/alternative; boundary="00000000000085757605c0897edc" --00000000000085757605c0897edc Content-Type: text/plain; charset="UTF-8" Hello Jython users, We use Jython to allow our customers to write extensions for our software written in Java. The public code is accessible in a jar, say *a.jar*, and the javadoc bundle for that jar is say, *a.zip*. Users writing non-trivial Python script extensions would like to use full-blown IDEs like Eclipse+pydev or PyCharm. I was wondering how to integrate javadoc as Python documentation within those projects: can those IDEs somewhat take the javadoc zip and figure out what doc entry to fetch and how to convert it from the javadoc html format? Example: a.jar contains com/abc/Foo.class; a.zip has a javadoc entry for Foo from com.abc import Foo a = Foo() I would like the IDE to know that the doc for com.abc.Foo is located in the javadoc zip archive, fetch it and offer it to the user. Do you know of any existing IDE plugin that could do that? Thank you, -- Nicolas Falliere ([email protected]) JEB Decompiler, Founder and Architect PNF Software <https://www.pnfsoftware.com/> | Follow us on Twitter <https://twitter.com/jebdec> | Join us on Slack <https://www.pnfsoftware.com/chat> | Bulletin Board <https://www.pnfsoftware.com/forum> --00000000000085757605c0897edc Content-Type: text/html; charset="UTF-8" Content-Transfer-Encoding: quoted-printable <div dir=3D"ltr">Hello Jython users,<div><br></div><div>We use Jython to al= low our customers to write extensions for our software written in Java. The= public code is accessible in a jar, say <b>a.jar</b>, and the javadoc bund= le for that jar is say, <b>a.zip</b>.</div><div><br></div><div>Users writin= g non-trivial Python script=C2=A0extensions would like to use full-blown ID= Es like Eclipse+pydev or PyCharm. I was wondering how to integrate javadoc = as Python documentation within those projects: can those IDEs somewhat take= the javadoc zip and figure out what doc entry to fetch and how to convert = it from the javadoc html format?</div><div><br></div><div>Example: a.jar co= ntains com/abc/Foo.class; a.zip has a javadoc entry for Foo</div><div><font= face=3D"monospace">from com.abc import Foo</font></div><div><font face=3D"= monospace">a =3D Foo()</font></div><div><br></div><div>I would like the IDE= to know that the doc for com.abc.Foo is located in the javadoc zip archive= , fetch it and offer it to the user.</div><div><br></div><div>Do you know o= f any existing IDE plugin that could do that?</div><div><br></div><div>Than= k you,<br clear=3D"all"><div><div dir=3D"ltr" data-smartmail=3D"gmail_signa= ture"><div dir=3D"ltr"><div><div dir=3D"ltr"><div><div dir=3D"ltr"><div><di= v dir=3D"ltr"><div><div dir=3D"ltr"><div dir=3D"ltr">--</div><div dir=3D"lt= r">Nicolas Falliere (<a href=3D"mailto:[email protected]" target=3D"_bla= nk">[email protected]</a>)<br>JEB Decompiler, Founder and Architect</div= ><div dir=3D"ltr"><a href=3D"https://www.pnfsoftware.com/" style=3D"font-si= ze:12.8px" target=3D"_blank">PNF Software</a><span style=3D"font-size:12.8p= x">=C2=A0</span><span style=3D"font-size:12.8px">|=C2=A0</span><a href=3D"h= ttps://twitter.com/jebdec" style=3D"font-size:12.8px" target=3D"_blank">Fol= low us on Twitter</a><span style=3D"font-size:12.8px">=C2=A0|=C2=A0</span><= a href=3D"https://www.pnfsoftware.com/chat" style=3D"font-size:12.8px" targ= et=3D"_blank">Join us on Slack</a>=C2=A0|=C2=A0<a href=3D"https://www.pnfso= ftware.com/forum" style=3D"font-size:12.8px" target=3D"_blank">Bulletin Boa= rd</a></div></div></div></div></div></div></div></div></div></div></div></d= iv></div></div> --00000000000085757605c0897edc-- --===============1295345966562316089== Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Content-Disposition: inline --===============1295345966562316089== Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Content-Disposition: inline _______________________________________________ Jython-users mailing list [email protected] https://lists.sourceforge.net/lists/listinfo/jython-users --===============1295345966562316089==--