What's the most efficient way to put as many bytes as possible from a ByteBuffer bbuf_src into another ByteBuffer bbuf_dest (as well as know how many bytes were transferred)? I'm trying bbuf_dest.put(bbuf_src) but it seems to want to throw a BufferOverflowException and I can't get the javadocs from Sun right now (network problems) when I...
The network between our company and Sun's javadocs seems to be down. Where can I get a copy of the javadocs for a given package, so that I can keep my own stash to handle network outages in the future? Are there any mirrors for the Sun javadocs? ...
Does anyone know of a way to output Javadoc, where line breaks are converted to tags? I find it quite annoying to have to remember to add tags on each line of my comments. Without br tags of course the entire comment is condensed into an unreadable block. Ideally the doclet would just replace the line break with a tag. I google'd...
Is there a reason to include both @version and @since as part of a class? They seem to be mutually exclusive. Also, what does %I% and %G% mean, and how to set/use them? @version %I%, %G% thanks ...
I have created java api -ported from C# to be more specific- which aside from public interface, contains a lot of internal stuff that I don't want a user to know about. In C#, I have used doxygen to generate documentation. I presume javadoc has similar features to exclude certain public members, classes, even packages. Would someone s...
Ok, let's leave the debate of whether friendship breaks encapsulation, and actually try elegantly come up with a coherent design. It is a two fold function: 1) General question on how to implement: public class A { friend class B; } 2) Why do I need this functionality? Some of my classes implement Serializable interfa...
I'm stuck with a legacy Java codebase that has THOUSANDS of warnings when you compile it. I would love to actually fix the source of all these warnings, but unfortunately that's not an option at this time at my company (other things like "making new products that generate revenue" are considered higher priority by the people in charge; f...
In the Java APIs I can see Javadoc comments for packages. How/where do I place Javadoc comments to document a package? ...
When programming in C++, I use Doxygen and frequently create external .dox files for additional documentation that won't fit well in a specific class or method - for instance, file format documentation (for files that are accessed by multiple classes). I tried to find a way to do the same in Java, but it appears that javadoc doesn't have...
How do I retrieve a list of deprecated methods from a class. I need to list the methods that have been marked as deprecated for a class to pass on to documentation. I don't really want to copy and paste each method and its javadoc into a seperate file, is it possible to do this through the javadoc tool or through eclipse? ...
I have a need to include */ in my JavaDoc comment. The problem is that this is also the same sequence for closing a comment. What the proper way to quote/escape this? Example: /** * Returns true if the specified string contains "*/". */ public boolean containsSpecialSequence(String str) Follow up: It appears I can use / for the...
/** * Gets the meatball icon for a nincompoop. * * <p> * Example: {@code <custom:meatball color="<%= Meatball.RED %> nincompoop="${person}" />} * * @author King Cong * */ The "${person}" part breaks the doc comment because it uses curly braces. Thanks in advance, LES ...
Is it possible to capture the warnings that Javadoc prints when run via the ant task? I don't see an output attribute such as the one in the task. There seem to be warnings that Checkstyle just isn't catching and it'd be nice to snag that output in a file. Seems strange this wouldn't be capturable, hopefully I'm missing something ob...
If you've used javadoc and then come to doxygen, you may know what I mean when I say I miss the hierarchical (frame-based) view that made jumping from class to class and method to method easy. (For those who haven't seen it, imagine a tree-navigator in an IDE or over a filesystem). Has anyone come across something more like that to vi...
Hi there, is there a way to search in javadoc comments only (via eclipse)? I just want to find text within a javadoc comment... Greets, Tobias ...
This question got me thinking in a regex for matching javadoc comments that include some specified text. For example, finding all javadoc fragments that include @deprecated: /** * Method1 * ..... * @deprecated * @return */ I manage to get to the expression /\*\*.*?@deprecated.*?\*/ but this fails in some cases like: /** * Method1 * ...
How do I write links into javadocs? Currently, I have something like: {@link java.lang.Math#sqrt(double) Math.sqrt} to produce the text Math.sqrt that should link to the java.lang.Math.sqrt(double) API; however, all it does is produce the text, no link. ...
I have generated an Interface which is very well documented. Every method does have his own JavaDoc. The clases which implement this Interface can have little differents in their logic. How can i add JavaDoc to the existing JavaDoc from the super class. The key word /** * {@inheritDoc} */ only set the javaDoc of the super class to...
Hi all, I'm trying to document an annotated interface and include a sample of how it's used in the javadoc. e.g. /** * Here's an example usage: * * <PRE> * @IFaceAnnotation(value="") * public interface IFace { * * @MethodAnnotation("") * public String Method(); * } * </PRE> */ However, Javadoc treats my annotations...
so i have this function: /** * @param parent ... * @param key ... * @param isRed ... * ... */ public redBlackNode(redBlackNode parent, int key, boolean isRed) { ... } and i cant see it or anything else that i documented in my javadoc... can someone please help. thanks! ...