Just start to learn Java, and always see some tutorials mentioning, "using the javaDoCs API to find...", what does "JavaDoCS API" stands for? Where to find it?
Javadocs are a way to write documents inside your code, that can be made into a little framed report dealio.
So for Java itself, you can get the Java 6 API at http://download.oracle.com/javase/6/docs/api/
if you are using say, Spring and someone says look at the JavaDocs API.. you would have to go google (or use something like Maven) to get the javadocs into your app.
Edit - Javadoc FAQ: http://java.sun.com/j2se/javadoc/faq/index.html
Javadocs are standard documentation pages generated from special comments inserted directly in the code.
You can find the whole thing for the standard API here: http://download.oracle.com/javase/6/docs/api/
Most IDES will also show you the API when you hit ctrl+space.
You will need the documentation or source files for non standard apis such as libraries / frameworks / etc.
Related
the OpenSMPP homepage does not contain the documentation of OpenSMPP itself, only the protocol references. Could somebody give me some advice where on Earth can I find documentation and code examples on how to use the OpenSMPP API itself, especially regarding what classes can be used for receiving asynchronously?
Thank you!
If you want to get the API (Javadoc)
- this will be resolved by your IDE if you include the library in your project follwing the instructions here http://opensmpp.org/downloads.html
- if you want to download the API manually start to have a look here https://oss.sonatype.org/content/groups/public/org/opensmpp/
For examples you could have a look in the unit tests, clone (or download) the project https://github.com/OpenSmpp/opensmpp.git and have a look for sources in the 'client/', 'sim/' or '*/test/' folders.
For testing purpose this tutorial might be also of interest: http://mobiforge.com/design-development/sending-sms-with-smpp-kannel-and-java
I need to find the replacement for the deprecated items in java. I found some description in javadoc about each and every deprecated items. But it's not sufficient.
To be more specific => I need to do a java program, which can read a java file and should replace the deprecated items used(if any) in that given java file with the appropriate replacement.
Is there any other source to find it?
OR
Is there any third party API's available to give the replacement for the deprecated itms?
OR
Is there any options available in eclipse to do this? -> I mean for example in the problems console of eclipse, we can able to find the warnings for the deprecated items used. Likewise, is there anything in eclipse which can show the replacement of the deprecated items in the project,
Please help me in this regard.
Thanks in advance,
Easwar
A #Deprecated API (method, class, whatever) is deprecated to notify you that a newer API exists that should be used instead of it. Exactly what the newer API is is not deterministic (i.e. is not something that can be inferred by eclipse or by analyzing the code). The only way to know what should be used instead of it is to read the documentation. If there is no documentation, there is no way of knowing apart from contacting someone who does know.
I am looking for good and practical resources that will help me use the Ant APIs effectively. The project website just gives the documentation of the API which is not useful at all. Very few websites seem to give very brief tutorials on the subject.
Is there some resource I am missing out on? How can I use the Ant APIs for simple tasks, without spending hours browsing through them and looking at source code?
Thanks.
(Answers to previously asked questions not helpful - How can i use Apache ANT Programmatically )
As it turns out, the lack of good resources on using the Ant API, is known and intended.
The bottom paragraph of this article from the Ant says -
The question you are probably asking yourself at this point is: How would I know which classes and methods have to be called in order to set up a dummy Project and Target? The answer is: you don't. Ultimately, you have to be willing to get your feet wet and read the source code. The above example is merely designed to whet your appetite and get you started. Go for it!
So this seems to be the only way to make best use of the API.
..Java program to programmatically build source files
If compiling/Jarring is all you need and you can run it in an SDK (as opposed to a plain JRE), look to the JavaCompiler class for compilation. Then use the Jar related classes to build the Jars.
All J2SE. Ant not included, Ant not required.
There is no better manual to understand ANT than : http://ant.apache.org/manual/index.html
I am not sure if you've gone through this link that explains in detail about creating a task. A word of caution, If you're new to ANT, there is no easy way to jump on this tutorial. Better to learn the basics before you come here. Refer above link for a good starting point.
Is there any free decent program to do code documentation for java?It's hard enough to get the coding project done and then need to spend time writing documentation as well.If you know, please tell me.
javadoc is the standard tool (included with the JDK) for Java source code documentation.
The standard Java API documentation has been generated with javadoc.
Well,
definitely there is javadoc. I think it is by far the most used tool for documenting java projects. Also, take into account that not only documents the methods and the classes but also you can document/create tutorials with static html pages and they'll appear in the generated documentation.
All the most popular IDEs (Eclipse, NetBeans for example) would generate the javadocs for you. It would list all the parameter, thrown exceptions etc. For obvious-purpose methods like getters and setters it will also generate good enough comments (getX() "Gets x" etc.). What you'll need to do than is to complete the javadoc comments for the classes and methods that are more sophisticated than getters, setters or default constructors.
There is also plenty of plugins (for Eclipse see here) that you can use for example to generate UML diagrams to illustrate your code structure.
Javadoc (as noted) is the standard tool for Java. However you may want to check out Doxygen, which will provide more powerful code navigation features and rendering options.
Automatically generated documentation sucks. Why have it? it doesn't add any value.
For years (more than a decade) I am using TallTree's DocJet (http://www.talltree.com/) to generate technical documentation from my Java/C++ code with very satisfactory results. The tool does not require any special tags (although it understands javadoc tags); it sufficient to describe class/method/field in plain English with occasional wording such as 'return' (or any other expression with the same meaning), "parameter" or "argument" and so on.
Are there similar documentation generation systems like Javadoc, for C++? Javadoc produces nice output; It would be great if you could use something like it in other languages.
There are several tools that works like JavaDoc for C++ The most popular tool is probably doxygen. It can handle JavaDoc-like comments, and also several languages (e.g., C++, C, Java, Objective-C, Python, PHP, C#). It has pretty good support for tweaking the style of the HTML output using CSS (see the users list for example documentations).
Two important issues when choosing the documentation system is to make sure that it allows you to
Document the entities that you are interested in. Do you want to document the system following the code structure or according to some other module division.
Getting the output formatted as you want. It is preferable when the documentation fits in with your general project style.
Our experience with doxygen is that it is pretty easy to set up and use, and the resulting output is fairly easy to tweak. Unfortunately, doxygen is not perfect, so in some cases it is necessary to work around quirks or bugs where the doxygen parser breaks down. Be sure to inspect all of your generated documentation carefully.
You can't use javadoc specifically, but there are a couple of tools that do what you want. The one most people tend to use is Doxygen. Here are some links for Doxygen and Doc++:
Doxygen
Doc++
There's doxygen that supports a lot of things (and more) Doxygen
There is also qdoc for QT based C++ projects. http://doc-snapshot.qt-project.org/qdoc
I'm just starting to use Sphinx for my Python projects. Its home page states "C/C++ is already supported as well".
It uses a lightweight markup called "reStructuredText".
I've just started using it for my Python projects, and like the look of the output very much.
From the Standardese home page:
Standardese aims to be a nextgen Doxygen.
It consists of two parts: a library and a tool.
The library aims at becoming the documentation frontend
that can be easily extended and customized. It parses C++
code with the help of libclang and provides access to it.
The tool drives the library to generate documentation
for user-specified files. It supports a couple of output
formats including Markdown and HTML as well as
experimental Latex and Man pages.
The Standardese code repository
also points to some blog posts:
Standardese - a (work-in-progress) nextgen Doxygen
Standardese documentation generator version 0.1
Standardese documentation generator version 0.2: Entity linking, index generation & more
Standardese documentation generator version 0.3: Groups, inline documentation, template mode & more
Standardese Documentation Generator: Post Mortem and My Open-Source Future