Creating java doc

i had ever used even a single comment in my program..
now i learned the java documentations theariticaly ..
please give me a guide how to create it .
iam using myeclipse ide..
say me what are the steps i have to follow in the following example..
* class used to find the total of the array
* @perimeter1 5.0, 6/9/2007
* @author shanmugapriya_2
* @version   %I%, %G%
* @since       1.0
* @author shanmugapriya_2
* @author shanmugapriya_2
* @author shanmugapriya_2
public class perimeter1
      * @param j array whose total is going to be find
     static int j[]={1,3,4,7,8,6};
     public static void main(String[] args)
          int i= perimeterCal(j.length-1);
          System.out.println(i);
      * @param b the length of the array whose total is going to be find
      * @return   total of the array
     static int perimeterCal(int b)
          if(b==0)
               return(j);
          else
               return(j[b]+perimeterCal(b-1));
is this is correct any thing else i have to add ..
i simply did it in the ide
there i don't know what is the use of @ since ,%i%,%G%
how to use {@link}
please guide me
Lots of thanks in advance..

in http://forum.java.sun.com/thread.jspa?threadID=430358&messageID=1922848
Answer was to start off here:
http://java.sun.com/j2se/javadoc/writingdoccomments/index.html
This is still corrrect.

Similar Messages

How to create java docs?

Hello,
Its probably a newbie question,can some please show me how to create java docs using java,I know that if I have comments started like this
@param
@return
Description
it will be shown in the docs,but what is the syntax to get this functionality,
thanks

On my system this information is in the directory C:\jdk1.3\docs\tooldocs\javadoc. Look in the analogous directory on your system.

Question about the java doc of String.intern() method

hi all, my native language is not english, and i have a problem when reading the java doc of String.intern() method. the following text is extract from the documentation:
When the intern method is invoked, if the pool already contains a string equal to this String object as determined by the equals(Object) method, then the string from the pool is returned. Otherwise, this String object is added to the pool and a reference to this String object is returned.
i just don't know the "a reference to this String object is returned" part, does the "the reference to this String" means the string that the java keyword "this" represents or the string newly add to the string pool?
eg,
String s=new String("abc"); //create a string
s.intern(); //add s to the string pool, and return what? s itself or the string just added to string pool?greate thanks!

Except for primitives (byte, char, short, int, long, float, double, boolean), every value that you store in a variable, pass as a method parameter, return from a method, etc., is always a reference, never an object.
String s = "abc"; // s hold a reference to a String object containing chars "abc"
foo(s); // we copy the reference in variable s and pass it to the foo() method.
String foo(String s) {
return s + "zzz"; // create a new String and return a reference that points to it.
s.intern(); //add s to the string pool, and return what? s itself or the string just added to string pool?intern returns a reference to the String object that's held in the pool. It's not clear whether the String object is copied, or if it's just a reference to the original String object. It's also not relevant.

How to know whether a method is thread-safe through the java-doc?

In some book, it says that SAXParserFactory.newSAXParser() is thread-safe,but in the java-doc,it doesn't say that.
newSAXParser
public abstract SAXParser newSAXParser()
throws ParserConfigurationException,
SAXExceptionCreates a new instance of a SAXParser using the currently configured factory parameters.
Returns:
A new instance of a SAXParser.
Throws:
ParserConfigurationException - if a parser cannot be created which satisfies the requested configuration.
SAXException - for SAX errors.
I want to know, how to know whether a method is thread-safe?

System.out is a PrintStream object. None of the methods there use the synchronized modifier, but if you look in the source code, you will find out it is thread-safe, because it will use synchronized blocks whenever it writes some text.
The source code is in the src.jar file which you can extract.
I didn't find any comments about that PrintStream is thread-safe in the API.

Java Docs for the Module Process Classes

Hi,
I would like to start creating my own JDBC and file-based modules for interface development. I have found several SDN contributions which step through the creation of these modules. These are very helpful.
However, I have not yet found comprehensive documentation describing the classes used in module develpment. i.e.:
- com.sap.aii.af.mp.module.Module
- com.sap.aii.af.mp.module.ModuleContext
- com.sap.aii.af.mp.module.ModuleData
Does anyone know where to find the Java Docs for these classes? Or is there any other equivalent explanation of how to use these classes, their methods and fields?
Any help would be greatly appreciated.
Carl Engel
CSC Australia

Hi Carl,
Another link for you
http://help.sap.com/saphelp_nw04/helpdata/en/87/3ef4403ae3db12e10000000a155106/frameset.htm
This says that the java documentation is available in the example adapter/module that is there with XI.
I vaguely remembering seeing the docu..it was long back though..right now i donot have access to a system...
Get the rar(java archive) that i talked about in the above link...
Thanks,
Renjith

Create java class/resource from binary blob in SQL statement

Is there a way of creating a java class or resource from a binary blob in the CREATE JAVA CLASS statement? Something like:
CREATE OR REPLACE JAVA CLASS
USING BLOB 'CAFEBABE0000003100120A0004000D08000E07000F0700100100063C696E69743E010003282956010004436F646501000F4C696E654E756D6265725461626C6501000372756E01001428294C6A6176612F6C616E672F537472696E673B01000A536F7572636546696C6501001152657475726E537472696E672E6A6176610C0005000601001F546869732069732061206E657720737472696E67207269676874206865726501000C52657475726E537472696E670100106A6176612F6C616E672F4F626A65637401000F6175726F72615F6F70745F696E666F002100030004000000000002000100050006000100070000001D00010001000000052AB70001B10000000100080000000600010000000100090009000A000100070000001B00010000000000031202B0000000010008000000060001000000030002000B00000002000C00110000004C00000000000004000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000009705070397050703';
I've tried various combinations of casting & convert functions, all of them give an ORA-29506 error 'Invalid query derived from USING clause', and nothing useful is gained from google about this. Is there a way of specifying the class binary in this way?

You can load Java classes into the database, then create a PL/SQL procedure or function in the database that calls that Java class.
This leaves you with a standard PL/SQL procedure/function which you can call from Oracle Forms.
Have a look at the database documentation on how to load a Java class: http://download.oracle.com/docs/cd/A91202_01/901_doc/java.901/a90210/toc.htm

Creating Java Proxies

Hi all,
We have a scenario for RFC -> Xi -> Java Application. We need to inoke certain functionlities provided by the java application through RFC. As per my understanding, i need to create the relevant interfaces and then invoke the java application by writing Java Proxies.
Can any body please suggest if:
1. My approach is correct? if no, then what is the possible solution?
2. If Its correct then how to create java proxies. Can any body please provide me a link to a blog with sample application?
Any help will be appriciated.
Thanks and best regards,
Kulwant Singh

Hi Kulwanth,
Java Proxies are Java Class files to access the R/3. If u create an RFC Model for a BAPI/RFC enabled FM the system will automatically create Java Proxy classes for ur R/3 connection.
The Java proxies for the message interfaces are generated using the Integration Builder tool (Design) in the menu Tools --> Java Proxy Generation and subsequently by selecting the message interfaces
Java proxies, the Integration Builder tool is used
1) The Java proxies for the message interfaces are generated using the Integration Builder tool (Design) in the menu Tools ---> Java Proxy Generation and subsequently by selecting the message interfaces.
Using the Java Proxy runtime we can Receive messages or Send messages to the Integration Server. The Java proxy runtime supports J2EE applications on the SAP J2EE Engine using Enterprise Java Beans 2.0. Synchronous and Asynchronous Outbound and Inbound communication is possible with Proxy Beans.
Check some links on proxies.
Concepts and examples for Proxy, Abap Client Proxy and Abap server Proxy
JAVA Proxies:
Asynchronous inbpund java Proxies
/people/prasad.ulagappan2/blog/2005/06/27/asynchronous-inbound-java-proxy
More on Java Proxy-
https://www.sdn.sap.com/irj/servlet/prt/portal/prtroot/docs/library/uuid/7d4db211-0d01-0010-1e8e-9b07fc2113ab
https://www.sdn.sap.com/irj/servlet/prt/portal/prtroot/docs/library/uuid/a068cf2f-0401-0010-2aa9-f5ae4b2096f9
https://www.sdn.sap.com/irj/servlet/prt/portal/prtroot/docs/library/uuid/f272165e-0401-0010-b4a1-e7eb8903501d
https://www.sdn.sap.com/irj/sdn/go/portal/prtroot/docs/library/uuid/a068cf2f-0401-0010-2aa9-f5ae4b2096f9
https://www.sdn.sap.com/irj/sdn/go/portal/prtroot/docs/library/uuid/f272165e-0401-0010-b4a1-e7eb8903501d
http://help.sap.com/saphelp_nw04/helpdata/en/14/80243b4a66ae0ce10000000a11402f/frameset.htm
SAP Exchange Infrastructure 3.0: Java Proxy Runtime 3.0 - J2EE Integration
https://www.sdn.sap.com/irj/sdn/go/portal/prtroot/docs/library/uuid/30572c6a-d311-2a10-99ab-f646ec3b5b12
How to Work with Java Proxies
https://www.sdn.sap.com/irj/sdn/go/portal/prtroot/docs/library/uuid/d06315a6-e66e-2910-039c-ba8bbbd23702
Java Proxies in XI
https://www.sdn.sap.com/irj/sdn/advancedsearch?cat=sdn_all&query=java+proxy&adv=false&sortby=cm_rnd_rankvalue#
Java Proxies in XI
https://www.sdn.sap.com/irj/sdn/advancedsearch?cat=sdn_all&query=java+proxy&adv=false&sortby=cm_rnd_rankvalue#
SAP Network Blog: Pre requisites for Client Java Proxies
/people/yugapreetha.t/blog/2007/12/03/pre-requisites-for-client-java-proxies
good docs on Java Proxy:
https://www.sdn.sap.com/irj/sdn/go/portal/prtroot/docs/library/uuid/7d4db211-0d01-0010-1e8e-9b07fc2113ab
https://www.sdn.sap.com/irj/sdn/go/portal/prtroot/docs/library/uuid/a068cf2f-0401-0010-2aa9-f5ae4b2096f9
https://www.sdn.sap.com/irj/sdn/go/portal/prtroot/docs/library/uuid/f272165e-0401-0010-b4a1-e7eb8903501d
/people/rashmi.ramalingam2/blog/2005/06/25/an-illustration-of-java-server-proxy
/people/srinivas.gv/blog/2005/09/27/concept-of-proxy-generation
Regards,
Vinod.

Can't create Java VM ?

Hi,
I tried to invoke JavaVM in C. And use the example from http://java.sun.com/docs/books/tutorial/native1.1/invoking/invo.html.
But when runed it after compiled it in Win32 with VC6.
It just can't create the VM. The following is the source:
========================================
#include <jni.h>
#ifdef _WIN32
#define PATH_SEPARATOR ';'
#else /* UNIX */
#define PATH_SEPARATOR ':'
#endif
#define USER_CLASSPATH "." /* where Prog.class is */
main() {
 JNIEnv *env;
 JavaVM *jvm;
 jint res;
 jclass cls;
 jmethodID mid;
 jstring jstr;
 jobjectArray args;
 char classpath[1024];
 JavaVMInitArgs vm_args;
 JavaVMOption options[4];
 options[0].optionString = "-Djava.compiler=NONE"; /* disable JIT */
 options[1].optionString = "-Djava.class.path=."; /* user classes */
 options[2].optionString = "-Djava.library.path=."; /* set native library path */
 options[3].optionString = "-verbose:jni"; /* print JNI-related messages */
 vm_args.version = JNI_VERSION_1_2;
 vm_args.options = options;
 vm_args.nOptions = 4;
 vm_args.ignoreUnrecognized = 1;
JNI_GetDefaultJavaVMInitArgs(&vm_args);
/* Append USER_CLASSPATH to the end of default system class path */
//sprintf(classpath, "%ls%c%s", vm_args.classpath, PATH_SEPARATOR, USER_CLASSPATH);
//vm_args.classpath = casspath;
/* Create the Java VM */
res = JNI_CreateJavaVM(&jvm, &env, &vm_args);
if (res < 0) {
fprintf(stderr, "Can't create Java VM\n");
exit(1);
cls = (*env)->FindClass(env, "Prog");
if (cls == 0) {
fprintf(stderr, "Can't find Prog class\n");
exit(1);
mid = (*env)->GetStaticMethodID(env, cls, "main", "([Ljava/lang/String;)V");
//mid = (*env)->GetMethodID(cls, "Yup","(I)Ljava/lang/String;"); /* Search the Method of class*/
if (mid == 0) {
fprintf(stderr, "Can't find Prog.main\n");
exit(1);
jstr = (*env)->NewStringUTF(env, " from C!");
if (jstr == 0) {
fprintf(stderr, "Out of memory\n");
exit(1);
args = (*env)->NewObjectArray(env, 1, (*env)->FindClass(env, "java/lang/String"), jstr);
if (args == 0) {
fprintf(stderr, "Out of memory\n");
exit(1);
(*env)->CallStaticVoidMethod(env, cls, mid, args);
(*jvm)->DestroyJavaVM(jvm);
========================================
Would you please to tell me why it failed and please show me a simple example ?
Best regards,
Eric

I have the same problem,
/* Create the Java VM */
res = JNI_CreateJavaVM(&jvm, (void **)&env,
nv, &vm_args);
if (res < 0) {
fprintf(stderr, "Can't create Java VM: %d\n",
%d\n", res);
exit(1);
res is -1...but I'm not using windows, I'm using Linux
and Solaris...Hi there,
I also have problem calling JNI_CreateJavaVM on Linux (returns -1). Have you been able to solve this in the meantime?

Newbie to Java Doc

Hello All,
I am pretty new to JavaDoc - i got a general hang of it and did some sample java doc generations for some java files to understand more better. Now I have been requested to create custom javadoc tags for an existing project. How do I go about this? It would be appreciated if anyone could help me out with pointers .
Thanks

Depending on how complex the produced output of your custom tags should be you can either use Javadoc's -tag option or write a custom Taglet.
See [http://java.sun.com/j2se/1.5.0/docs/tooldocs/windows/javadoc.html#tag] and [http://java.sun.com/j2se/1.5.0/docs/guide/javadoc/taglet/overview.html] for related documentation.

How to create java archive using jar command

hello
what is the syntax for creating java acrchive using jar command line
jar -c ???????
urgent plzz

jar cf myjar.jar classfiles...
If you have a manifest file you want to add:
jar cfm myjar.jar manifest.mf classfiles...
Also check the documentation:
http://java.sun.com/j2se/1.3/docs/tooldocs/tools.html
You can find a link to jar there.

How create MS Doc file ?

Hi
I want to create MS Doc file from java, which API I can make use of?
And if there are many, pls let me know which one is better.
Thanks

NKjavaforum wrote:
Hi
I want to create MS Doc file from java, which API I can make use of?
And if there are many, pls let me know which one is better.
ThanksDon't. Create an RTF document with a .doc extension.
How to create a RTF? It depends on what you want to do with it. If have a fixed template that you just want to squish data into then I would spit out an XML file with said data then XSLT to a XSL:FO¹ and use [Apache FOP|http://xmlgraphics.apache.org/fop/].
1) Or skip the XML/XSLT step and spit out XSL:FO.

Java.Doc

Having problems using command line to access java.doc
also can,t find a example using the various keywords.
want to try the java.doc but very new to java,
i,ve looked at the tutorial but still confused any help appreciated
Thank you

The javadoc tool has to be one of the sexiest things
ever created
atThePrompt>javadoc MyJavaApplictionIdentifierName
try adding a comment such as this to your application
** this is a javadoc comment
Well sexy or what?
Thank you ,
stuff adult sites when you,ve got javadocand the furry animals to back it up
<cough!>(in a manner of speaking of course)

Display java docs

When a certain button is clicked I would like to show the java docs that I have created, It does display but not very well and it keeps showing the below error in my JEditorPane.
<H2>
Frame Alert</H2>

This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client.
 
Link to<A HREF="overview-summary.html">Non-frame version.</A>Below is the code I am using to display my javadocs
import java.awt.Dimension;
import java.io.IOException;
import javax.swing.*;
public class APIDialog {
 private String apiFileName = "file:///F:/NetBeansProjects/TrussOptimizater/dist/javadoc/index.html";
 public APIDialog() {
 public void createGui() {
 JEditorPane ep = null;
 try {
 ep = new JEditorPane(apiFileName);
 ep.setPreferredSize(new Dimension(400, 400));
 } catch (IOException ex) {
 System.out.println("Error reading in javadocs " + ex);
 JDialog dialog = null;
 dialog = new JDialog(dialog, "Test", false);
 dialog.add(ep);
 dialog.setResizable(false);
 dialog.setDefaultCloseOperation(JDialog.DISPOSE_ON_CLOSE);
 dialog.pack();
 dialog.setVisible(true);
}Any ideas?
Thanks in advance

JEditorPane doesn't support all HTML features. Perhaps you could use Desktop#browse(...) or open(...) instead.
db

Java Docs info for IDataConnection

Hi, I need to create universe connection from java.IDataConnection object is used for this, but I can't find any java docs for it!Maybe someone knows?Thanks!Alex

Â Hi Alex
Do you want to create a universe or create a connection to an existing universe?Â We only have a COM SDK for creating Universes.Â You can find this SDK in the Developer Library under 'Universe Designer and Desktop Intelligence SDK:
[http://devlibrary.businessobjects.com | http://devlibrary.businessobjects.com/]
My guess is that you only want to create a connection to an existing Universe using the WebI SDK.Â Is this right?Â Where are you getting your reference to the IDataConnection object.Â I couldn't find any references to it.Â
It might be easier if you explain the work flow that you are trying to accomplish.
thanks,
Rob Horne
http://diamond.businessobjects.com/blog/10

Create java session within portlet

We are integrating our application JSP/Servlet/Beans to 9ias R2. URL portlet is out of question, so how would it be possible to create java session within a java portlet, then accessed by the application, which sits at different instance? An example will be great.
Thanks

HI Jim,
You can refer to "adding.session.storage.pdk.java.v2.html" document - a part of PDK download. This doc might be of use.
Thanks,
Ravi

Creating java doc

Similar Messages

Maybe you are looking for