Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.
We don’t allow questions seeking recommendations for books, tools, software libraries, and more. You can edit the question so it can be answered with facts and citations.
Closed 5 years ago.
Improve this question
Our company has a very large public Java API which is currently being released standalone and online using (of course) JavaDoc. It is surrounded by product documentation which links into the API.
We are moving our static documentation to DokuWiki - which works pretty good - and want to keep the links.
Now it would be good to have a method (or doclet) that exports the JavaDoc directly into DokuWiki - or a very near alternative.
Question: Is there something like this or do you know a method to do just that?
Here's a Doclet which writes to JSON.
https://bitbucket.org/ananelson/json-doclet/src/tip/src/it/dexy/jsondoclet/Doclet.java
It might help get you started writing a custom Doclet.
You need to write doclet yourself, its not hard - its just html generation from very nice meta-model.
this might help
P.S. doclet api is in lib/tools.jar of your sdk.
Related
Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.
We don’t allow questions seeking recommendations for books, tools, software libraries, and more. You can edit the question so it can be answered with facts and citations.
Closed 5 years ago.
Improve this question
Are there any plugins out there (similar to Swagger) which provide the ability to document HATEOAS APIs?
The Swagger interface is quite good but it doesn't have level 3 REST support.
I use spring-restdocs in combination with the HAL-browser.
You don't necessarily need HAL for restdocs though, although it is recommended.
Restdocs will generate code samples and link & field descriptors in the asciidoc format. You can then link to these asciidocs from inside the HAL-browser.
To see the result in action (although this is hardcoded), check this out: foxycart. Click on the little doc links next to the rels.
After further investigation I discovered HAL-browser (https://github.com/mikekelly/hal-browser) which is quite good. Although, your API must return content-type of HAL for it.
You don't need to configure anything on the server for this tool. Just open it in a browser and point to your API.
Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.
We don’t allow questions seeking recommendations for books, tools, software libraries, and more. You can edit the question so it can be answered with facts and citations.
Closed 4 years ago.
Improve this question
Details on the packages/types is in the Scala API documentation on scala-lang.org. But that's organised by class and I (as a Scala neophyte) find it difficult to locate the exact data type I need and work out what operation are supported on what (especially in the huge and powerful scala.collections.* tree).
Is there an online or dead-tree resource that either presents this reference information more usably, or guides the reader through the library?
Alternatively, maybe I just need to be informed how to use the existing Scala API doc website more effectively.
Any advice on effective use of the standard Scala library gratefully received!
For the collections in particular, there's a very good overview available here: http://www.scala-lang.org/docu/files/collections-api/collections.html
Written by Martin Odersky himself :)
Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.
We don’t allow questions seeking recommendations for books, tools, software libraries, and more. You can edit the question so it can be answered with facts and citations.
Closed 5 years ago.
Improve this question
Are the JavaDocs for clojure.lang, etc. available online? Do I need to build it myself from the Clojure source?
Thanks.
if you want descriptions for functions and even examples, visit ClojureDocs
you can even contribute ;)
Javadocs don't exist, per se. If you look at the Java source code, it's very sparsely documented. Certainly you could generate a skeleton yourself, but it probably wouldn't be all that useful anyway as much of the language is self-implemented (in clojure), using Java mostly for bootstrapping the core functionality. I don't think clojure.lang package is really intended to be used directly.
To learn about Clojure functions you can:
Use (doc) and (find-doc) from a repl
Use the API reference at clojure.org
See ClojureDocs, per #Belun's answer
Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.
We don’t allow questions seeking recommendations for books, tools, software libraries, and more. You can edit the question so it can be answered with facts and citations.
Closed 4 years ago.
Improve this question
Does anyone know if there is something like a Limewire API? I need to be able to make Limewire download files programmatically.
EDIT: It seems Limiwire doesn't have an API. Is there any other Gnutella P2P cliente that does?
I suppose focusing a little more upon your requirement, you've got the Gnutella downloader service/class/package API thing.
http://wiki.limewire.org/index.php?title=Gnutella_downloader
It allows you to query and download direct to the network.
Then extending that idea - you have jTella, API source for Gnutella network.
http://sourceforge.net/projects/jtella/
Unfortunately, there is not. Also, unfortunate: the source code is terribly difficult to read/modify. If, however, you're up to the challenge, then you can simply write your own application on top of limewire-core, which is seperate form the GUI.
Not sure about a true api - but I found this by googling your title:
http://wiki.limewire.org/index.php?title=Javadocs
Seems to be built in Java. Entire set of packages seem to be there too.
Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.
We don’t allow questions seeking recommendations for books, tools, software libraries, and more. You can edit the question so it can be answered with facts and citations.
Closed 5 years ago.
Improve this question
I would like to create some documentation and post it onto my Joomla website. This documentation would be something along the lines of the MSDN documentation: i.e. each page would follow a basic template.
Intuitively I feel I have two ways of achieving this:
1) Creating each page of documentation as a separate article, and then linking them up.
2) Creating some kind of template and filling the information from a database.
The second option being preferable in the long run. Unforunately I have no idea how to achieve what I'm looking for. I hoped that there would be a component out there that woud help me, but Googling for 'Joomla Documentation' just brings up the documentation for Joomla itself.
Has anyone out there put documentation on their site, and how did they achieve it?
You're probably best off using one of the content construction kits (CCKs) available for Joomla: http://extensions.joomla.org/extensions/news-production/content-construction These allow you to define preset fields for each article.