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
I was asked in class to look for libraries along with their operation and documentation type. This is the first time I'm hearing or having anything to do with library documentation. I tried looking for some form of clear and concise explanation of what it is but I don't think I've actually understood what it is and its importance.
Can someone explain to me what is meant by documentation type and where can I find more details of a particular library's documentation?
Documentation has all the information you need to make use of the library. There are code samples, tutorials, developer guides, API documentation, and more to quickly understand the library and use it.
Actually API documentation is mostly developers look while using particular library.
It has technical content deliverable, containing instructions about how to effectively use and integrate with an API. It’s a concise reference manual contains all the information required to work with the API, with details about the functions, classes, return types, arguments and more, supported by tutorials and examples.
If you talk about JAVA 7 https://docs.oracle.com/javase/7/docs/api/ is the documentation.
Java APIs are most often documented with JavaDoc. Whether it is generated and shared online or with the library varies from library to library. Other types could be wiki pages, web pages, or other text docs, manuals, reference materials. Pick a couple of popular libraries and then look for their docs. What did you find?
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
I am using MireDot for generating documentation for my REST service.
While it is awesome for generating the models and general information on the resources, I don't believe it currently has a way of "nicely" adding concrete example input/output.
That said, I am resorting to pure JavaDoc for writing the Json examples. And it's painful.
Does anybody know of any tool out there that helps write JavaDoc... and in particular makes it easy to insert formatted JSON/etc into it?
This is an old question I posted when I was just experimenting with ways to document an API.
Eventually I switched to Apiary over MireDot, which makes this task trivial. The reason for this transition was mostly to decouple the JavaDoc from the actual API documentation, as I found coupling those two can create a very messy code-base for a sophisticated API that requires a lot of documentation.
Ideally would have built documentation using an all-encompassing API management platform like Mashery or the like, but at the time that was not an option.
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
This question is a bit vague but I'd like to know if there's a Java tool that can run through my code and document it in a functional way. Is JavaDoc the only way to go, or are there alternatives?
JavaDoc is a good way of generating reference documentation. You can use custom doclets to adapt it to your needs (in look, functionality or extra bells-and-whistle) but it is still essentially still a list of methods and their descriptions.
Documenting enterprise software is more about documenting higher level stuff like design information, architecture, component interactions, etc. There's no software tool I know of that will do this for you automatically (reverse engineering tools will mostly produce a mess), but there are many content management systems that can help you organize and present it better.
You could also write a JavaDoc alternative (or use something existing) that uses reflection to analyze a class library and produce stuff, possibly with your help via annotations. For instance, there are research tools that let you place architectural constraints within your code, that are then used for conformance testing and possibly for documentation.
It all depends on what you want out of the generated documentation. JavaDoc is the standard way to do API documentation in Java, so that's probably your best starting point. There's actually a Doclet API if you just need to tweak the output. One example of the Doclet API in action is the UMLGraph doclet that can embed UML graphs in your JavaDoc output.
If you just hate JavaDoc, there's always things like Doxygen.
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
I want to use Pie, Bar, Line charts in java. What is the best API to use them? Is there any API by Sun to create these types of charts?
take a look at JFreeChart.. it's not by SUN but it's quite notorious (and by the way I don't think JDK ships with any kind of graph API)
Use JFreeChart like everyone who responded suggested or if that doesn't work for you check this SO question:
what-is-the-best-open-source-java-charting-library-other-than-jfreechart
Use jFreeChart
"JFreeChart is "open source" or, more specifically, free software. It is distributed under the terms of the GNU Lesser General Public Licence (LGPL), which permits use in proprietary applications."
JFreeChart is free to use, and there are numerous "simple" examples on their website, as well as API documentation.
If it's useful to you, and if you start using anything more than really basic graphs, you might consider purchasing the full documentation with more detailed examples and guides on how to use it to the max of its power. It will certainly boost your productivity and also help to support the project.
I couldn't find any documentation about JFreeChart, so I forked jcckit to https://bitbucket.org/hughperkins/easyjcckit , and added a simple 'plot(double[] xvalues, double[] yvalues )' method for line graphs.
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 7 years ago.
Improve this question
I saw this post :
https://stackoverflow.com/questions/441198/has-anyone-learned-how-to-program-in-21-days/441224#441224
and I'm not familiar with java APIs, which books do you think will really help me get familiar with those APIs?
Java in a Nutshell, David Flanagan
Java has lots of APIs! Which ones are you interested in becoming familiar with?
What's nice, though, is that Javadocs tend to make APIs easy to learn, by providing method signatures and short descriptions.
Many APIs also have more in-depth tutorials online that you can read. In many cases this can be easier / more accessible / cheaper than buying books.
I would start off with Java Collections, as they are used in most Java applications: http://java.sun.com/docs/books/tutorial/collections/index.html
Note that this is one of Sun's "Trail" tutorials, which are very helpful. Check out the others as well, for those libraries that you are interested in learning. Here is the main index: http://java.sun.com/docs/books/tutorial/index.html
Effective Java by Josh Bloch
You should really start at http://java.sun.com/docs/books/tutorial/index.html
These tutorials are well written, and will get you up to speed quickly. For all the details, go to the documentation at http://java.sun.com/javase/6/docs/api/
If you insist on a book, Thinking in Java by Eckel is not bad, though Eckel can be a bit longwinded and obtuse.
Java Cookbook contains examples to many API's
Then javadoc can be used to adapt to own requirements.
Java 7- complete reference This books not out yet but it might help a lot along with the java docs and all the additional material the others have mentioned.
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 7 years ago.
Improve this question
I'm currently designing a Java application where a Rule engine could be useful. Where is a good place I can learn about how to use them, how they work, how to implement them, see samples, etc.?
The Drools documentation includes a lot of useful, general purpose information. Especially chapter 2, which covers rule engine basics, knowledge representation, etc. It also includes a nice recommended reading list for coming up to speed on rule engines and expert systems.
For most rule engines, a basic understanding of the rete algorithm usually comes in handy for writing efficient rules. I have personally found the Doorenbos paper referenced in the Wikipedia article to be the clearest technical explanation.
Also, here is a list of open source rule engines in Java.
You might want to read "Should I use a Rules Engine?" from Martin Fowler's blog.
I have worked on a project where we built our own (very simple) rules engine, with the intention to move to a general rule engine when things got too complicated. Never reached that point though, the system has been running happily with the simple homegrown engine for several years now.
I found this site pretty helpful. Are you looking at building your own, or using a 3rd party library?