Generating docs of specific methods only

Folks i have two questions
1. I have a project in which the directory structure is as follows
src/mpi
src/mpjdev
src/runtime
src/mpjbuf
Now i want to generate the javadocs of src/mpi only. How can we do it? What if i want that i want to exlude some files from the src/mpi package. Please provide some snippets
2. Now after generating the "selected" javadocs of src/mpi, i want to go one step further. There are many methods in the class of which i donot want the javadocs to be generated. Same applies for many fields. What can i do in the source files so that the javadocs of only those methods should get generated which i want and not of all the methods and fields....
Can any one help?

First off, I want to mention that the [Javadoc Tool Homepage|http://java.sun.com/j2se/javadoc/] is a very good place to read up on Javadoc features and configuration.
KamranHameed wrote:
Folks i have two questions
1. I have a project in which the directory structure is as follows
src/mpi
src/mpjdev
src/runtime
src/mpjbuf
Now i want to generate the javadocs of src/mpi only. How can we do it? What if i want that i want to exlude some files from the src/mpi package. Please provide some snippetsWell, basically javadoc supports explicitly specifying source files that should be documented. E.g. if there a three source filessrc/mpi/A.java
src/mpi/B.java
src/mpi/C.javaand you only want to document A and B you could invoke javadoc from the command line the following wayjavadoc -d doc/api src/mpi/A.java src/mpi/B.java(with -d doc/api specifying the destination of the generated documentation files). Of course, this approach is quite unwieldly as the number of files in a project grows. Fortunately, there are many build tools that provide a more convenient way to specify "filesets". E.g. ANT's Javadoc task supports an inclusion/exclusion mechanism for source files:<target name="javadoc-sample>
<javadoc destdir="doc/api">
    <fileset dir="src" defaultexcludes="yes">
      <include name="mpi/**/*.java"/>
      <exclude name="**/C.java"/>
    </fileset>
</javadoc>
</target>For more information on ANT see [http://ant.apache.org/].
{quote:title=KamranHameed wrote:}{quote}
2. Now after generating the "selected" javadocs of src/mpi, i want to go one step further. There are many methods in the class of which i donot want the javadocs to be generated. Same applies for many fields. What can i do in the source files so that the javadocs of only those methods should get generated which i want and not of all the methods and fields....Javadoc supports filtering members by visibility using options -public, -protected, -package, -private (defaulting to -protected). For information on these options see [http://java.sun.com/j2se/1.5.0/docs/tooldocs/windows/javadoc.html#javadocoptions]. If you need to filter members on some other criteria (e.g. never display methods whose name starts with "test" regardless of visibility), then you will have to use some other tool. yWorks' yDoc, for example, is a commercial Javadoc extension that allows users to exclude members from documentation by adding a special Javadoc tag to the corresponding documentation comment but also allows for sophisticated custom filtering.
{quote:title=KamranHameed wrote:}{quote}
Can any one help?Well, I hope I did that just now. ;-)

Similar Messages

Restrict access to a specific method in JSE

Hello all,
I'd like to know if there is a way to restrict access to a specific method in JSE. Basically, my intention is to do this:
Subject.doAs(subject, new ProtectedMethod());
// only users with a specific role can access this method
// (permission specified in my policy file?)
public class ProtectedMethod implements PrivilegedAction<String> {
public String run() {
}I believe that is not possible to specify a method name in policy file via java.lang.RuntimePermission "accessDeclaredMembers", so is there another way to do this?
Thanks in advance,
Andre

I am not an expert of this media hub, but what I would like to know is that are you referring to the security you have setup with the original folders? So after you have created a backup, whatever type of access you have setup was removed? Can you please elaborate?
Check the FAQ's for NMH305 from here: http://support.linksys.com/en-us/support/storage/NMH305

Homogeneous system copy ( sapinst or db specific method )

I want to make homogeneous system copy ( NW7 ) of ECC6 from PRD to make a QA system on HPUX/Oracle environment. I am wondering which of the following method is better way to go
System copy with the help of sapinst
or
Database specific method
What are the steps of each method?
Please help, your help will be highly appreciated.
Best Regards,
-Al

Hi Al,
Using sapinst is the supported method by SAP but it takes much longer as you'll need to export/import the data and doing this affects availability of your PRD system. Most companies perform DB backup/restore as it is much quicker and does not require an outage of your PRD system (if you have online backups). Different databases have different tools for this operations. Since it only a QA system, I would suggest you do a DB backup/restore.
Regards,
Thomas Pham

How to execute a specific function only in DEBUG and AdHoc modes

Hi,
What i would like to do is a simple button with an action method, This button is initialized, created, assigned to its action method and shown ONLY in Debug and AdHoc modes. So as a developer or tester, i can see the button, but in the release, the client won't be able to see that button.
What i did so far is the following:
-In my project-->Build Settings Tab, i set the Debug values to 1 in both Debug and Adhoc, like this:
-Then i opened up the prefix.pch file, and there, i am blocked and i don't know what to do.
Basically, my action method is something like this:
UIButton btnSwitch=[[UIButton alloc]init];
//Etc...
The above code should be called in a specific file (The UIViewController class which should contain the button).
How can i do that, i mean, how can i tell my application to execute that code in a specifi file only in DEBUG and Adhoc modes.
Thanx in advance.

Hi,
What i would like to do is a simple button with an action method, This button is initialized, created, assigned to its action method and shown ONLY in Debug and AdHoc modes. So as a developer or tester, i can see the button, but in the release, the client won't be able to see that button.
What i did so far is the following:
-In my project-->Build Settings Tab, i set the Debug values to 1 in both Debug and Adhoc, like this:
-Then i opened up the prefix.pch file, and there, i am blocked and i don't know what to do.
Basically, my action method is something like this:
UIButton btnSwitch=[[UIButton alloc]init];
//Etc...
The above code should be called in a specific file (The UIViewController class which should contain the button).
How can i do that, i mean, how can i tell my application to execute that code in a specifi file only in DEBUG and Adhoc modes.
Thanx in advance.

Enums with constant-specific method implementation

Just faced the following problem. I have a persistent class with one of the fields of it is enum with constant-specific method implementation:
@Persistent
public class Message
   static public enum Type
       DEFAULT
           @Override
           public String getDescription() { return "Some description"; }
       public abstract String getDescription();
   private Type type;
}When I try to store the record, I get the exception:
java.lang.IllegalArgumentException: Class could not be loaded or is not persistent: messages.Message$Type$1The problem seem to be in that compiler creates a separate class, namely Message$Type$1.class for the DEFAULT instance and this class is not known by BDB..
If I remove the constant-specific method from enum, everything's working fine (as the ..$1.class is not created by compiler).. Except the fact that I'd like to have constant-specific methods there..
Any ideas on this? Maybe it's a bad idea to create constant-specific methods if it means that each constant would get own class file (and they would bloat the storage routines)?

Hi Mikhail,
I recreated the problem here and you're right, constant-specific methods aren't working. This isn't something we thought about, to be honest, or tested.
Just based on an initial quick look I see that for the compiler generated class, the Class.isEnum method returns false, which is why we don't recognize this as an enum and eventually why we throw the exception you're seeing. But assuming that we can identify the class as an enum (that shouldn't be too difficult) I don't know what other problems we will run into in trying to support this.
For now I think the best thing is to avoid using the constant-specific methods. I have opened a ticket (#18357) so that we'll remember to look into this in more detail and see whether it can be supported in the future.
If we are able to support it, then I'm hoping that we won't to store extra metadata for constants that have methods. In other words, I'm hoping that we won't have to add any extra storage or processing overhead.
--mark

Apply script on specific pages only

Hi!
I would like to know how to apply some script on specific pages only.
I would like to apply it on pages number 4 to 50 on a 50 page project, and so exclude page 1, 2 and 3.
Here is my actual script:
var doc = app.activeDocument,
objStyle = doc.objectStyles.itemByName('stylenamechosen'),
a = doc.allGraphics,
i = a.length;
while( i-- ) a[i].parent.appliedObjectStyle = objStyle;
Please let me know.

Dear Jump_Over,
Sorry for the delay...
//below code working fine
var myDoc = app.activeDocument;
var myGraphics = myDoc.allGraphics;
for(k=0; k<myGraphics.length; k++)
    myGraphics[k].parent.appliedObjectStyle = myDoc.objectStyles.item("testing");
//below code not working with page range
var myDoc = app.activeDocument;
var myGraphics = app.activeDocument.pages.itemByRange(3, -1).allGraphics;    //Error found in this line
for(k=0; k<myGraphics.length; k++)
    myGraphics[k].parent.appliedObjectStyle = myDoc.objectStyles.item("testing");
Document having 10 pages.
Thanks
Beginner

Java Most Specific Method

Considering the most specific method in overriden methods, could somebody explain as to what would be the output of the following program and why ?
public class SuperClass {
     public void methodA()
          System.out.println("Name from Super One");
     public void methodA(String... str)
          System.out.println("Name from Super Two");
public class BaseClass extends SuperClass {
     public void methodA(String str)
          System.out.println("Name from Derived");
     public static void main(String args[])
          SuperClass sc=new BaseClass();
          sc.methodA("str");
Edited by: 839760 on Feb 24, 2011 11:23 PM

Or get the real facts from [url http://java.sun.com/docs/books/jls/third_edition/html/expressions.html#15.12.1]the horse's mouth. But try Kayaman's idea first.
Winston
Edited by: YoungWinston on Feb 25, 2011 3:24 PM
Actually, [url http://java.sun.com/docs/books/jls/third_edition/html/expressions.html#15.12.2.5]this section is, I think, a bit more specific to what you want to know.

How do I convert a read only word doc to a read only pdf file?

How do I convert a read only word doc to a read only pdf file?
Thanks, Linda

Hi Linda,
I just tried it, and was able to convert a Word .doc to to PDF, in spite of the fact that it was marked Read Only. Here are the instructions for uploading and converting to PDF with Acrobat.com:
http://help.adobe.com/en_US/Acrobat.com/Acrobat/WS396AAA88-4AA4-4a40-87B8-004A5DC1E131.htm l
Kind Regards,
Michelle

Pls give me the code to load method only once in JVM.

Hi all,
Pls give me the code to execute method only once in JVM.Even if we create more than one instance to call the method.
Thanks & Regards,
Vinodh

[How to ask a question on these forums|http://catb.org/~esr/faqs/smart-questions.html]

Why java allow start() method only once for a thread

Hi ,
Why java allows start method only once for thread . suppose
Thread t = new Thread();
t.start();
say at later stage if again we call t.start() IllegalStateException is thrown , even though isAlive method returns false.
Hence the question , why start() method is allowed only once.If you need start a thread , we need to create a new instance.

Really. Why do you think that? Do you have any evidence? It is one of the first things I would think of, personally.Considering that the Thread API doesn't allow you to specify a stack address (only stack size), I think it demonstrates they wanted to remove that capability from their Thread API all together. That missing "capability" makes me believe they want me to believe it's not something I need to worry about when using their API... I think the exact semantics of the Thread class and its methods were driven by how to make it most understandable and usable for their customers. I'm certain this issue was one of many that was given considerable thought during the design and implementation of the JVM and the underlying runtime classes.
Do I have any evidence? No. But if you can point me at some first-hand information on this, I'd love to read it. Most of what I've found is second or third hand accounts. (and I mean that sincerely, not as a smart-ass remark or rebuke of your comments).
On the one hand you seem to think the Java API designers are idiots, on the other hand you think that they should be. I can't make it out.I thought my position was that the Java developers were talented enough to implement platform in whatever way their API called for; hence, the designers made a choice about how they wanted their API to be used by their customers. They decided which capabilities they wanted to include or exclude, and created an API that was consistent with their vision for this technology. While I'm certain technical limitations had an effect on the API design, I certainly don't think the API was dictated by the them.
I think the current design of the Java Thread API was a reflection of their vision to make Threading easier and more accessible to Joe Programmer, not limitations in the implementation. I never said it was wrong or that I could do better... I just said I think they could have done something different if they decided it would have made for a better customer experience. But hey, maybe I'm wrong.

Netflix on iPad with restrictions set to only allow "Specific Websites Only"

I have Netflix app installed on my child's iPad. I have restrictions in place on the iPad too - Website restrictions set to "Specific Websites Only".
When I do this the netflix app just spins (never gets to the Netflix login).
If I remove restrictions to allow "All Websites" Netflix works.
I also allowed www.netflix.com as an Allowed Website. Also set Safari "Block Cookies" to never to see if this would help. No luck.
I want Netflix to work, but I also want the restrictions on the iPad to be set to "Specific Websites Only".
Netflix support said (tried them first):
Just spoke with my team who informed me that they have received a few of these complaints. The Netflix app was introduced on the Ipad as a partnership with Apple. We do not have much control over the function of of the permission on the device. They have asked that you reach out to Apple to determine if there is a work around.
Anyone know how to fix this???

hello msreyes,
after countless hours of googling for answers i came up with a solution that works on my situation...it could work for you, its not 100% kids-proof (if your child is tech-savvy then maybe this wont work for you but anyways...)
first step go Settings/ General/ Safari and set your search engine
then Go to Settings/ General/ Restrictions/ Enter your passcode, after you set your restrictions (obviously this step differ from parents to kids age) just for reference here are my screenshots of how i managed the kids phone
ok, so now to the point...next i checked "Limit Adult Content"
and finally you type as many "search engine" and "social media" websites you can possible find. " i know that could be quite allot of URL's but by you having Google as "default serarch enigine and also having www.google.com in th the "NEVER ALLOW" section you kind of take away the "avility" to easly browse Safary,
so say your child types facebook in safari search bar it will show a " website is restricted" message, thus not allowing google or any websites you strict "for that matter" to let your child roam free in the internet world.
and to wrap things up, you can now use Netflix's app in you iPhone. and perhaps your child will never find a walk around glitch..

Transaction timeout configuration for specific method

          Hi,
          How can i configure a transaction timeout for a specific method in EJB using a
          deployment descriptor (using weblogic 8.1)
          Amos.S


There is another way but I think it's more complicated.
After reading the file you can use a java code (java embedded activity) and split the file.
For each part of the split you can PUT by FTP the file with append mode. That way your transaction will run in few cycles with less time.

Install itunes to a specific user only

I want to install itunes for a specific user only. Currently both users are administrators however i want the itunes/quicktime installation to reflect on 1 user only i.e. the one i intall it from. How can i do this? Is there a command line parameter that would allow me to install it for 'current user' only? Please advise.

Just change the installation path to somewhere in the other users account. The default is C:\Program Files\iTunes. You could change it to something like
C:\Users\accountname\iTunes. or something like that for vista. and
C:\Documents and Settings\accountname\iTunes. or something like that for XP.
accountname is the name of the account that you are trying to install itunes for.

How to resolve error 'The DPMRA service terminated with service-specific error Only one usage of each socket address (protocol/network address/port) is normally permitted'

One of my exchange 2010 servers dpm agent is give the following error when the dpmra service attempts to start.
The DPMRA service terminated with service-specific error Only one usage of each socket address (protocol/network address/port) is normally permitted..
I have tried uninstalling/reinstalling the agent but this does not resolve the issue
Any help would be greatly appreciated.
Thanks
William Hickson

Hi
Something has probably changed on the protected server side that affects the DPM agent. In some cases the DCOM configuration could change. Look at this blogpost and verify your DPMRA DCOM object.
http://robertanddpm.blogspot.com/2010/08/dpm-ra-rights.html
If this doesn't do the trick try reinstall the agent.
Best Regards
Robert Hedblom
MVP DPM
Check out my DPM blog @ http://robertanddpm.blogspot.com

Problems with generating an app specific password

Hi,
I feel there must be an obvious solution, but i couldn't find it anywhere. My problem is that when I log in to my Apple ID and click on Password and Security tab there are just following options: Choose a new password. Security Questions. Rescue Email Address Select your birth date. So there is no "Generate an app specific password" as it it written in the instructions ... what am I missing out?
Thanks for your help!

Sorry, forgot to write: Using app-specific passwords
it says:
Generate app-specific passwords
Before you sign in to iCloud using a third party app, follow the steps below to generate an app-specific password:
Go to My Apple ID.
Select Manage your Apple ID and sign in.
Select Password and Security.
Click Generate an App-Specific Password and follow the steps on your screen.
After you generate your app-specific password, enter or paste it into the password field of the third party app as you would normally.

Generating docs of specific methods only

Similar Messages

Maybe you are looking for