As of 1.5 you can define a `package-info.java` file and provide a standard javadoc style comment for a package:

com/foo/package-info.java:

    /**
     * com.foo is a group of bar utils for operating on foo things.
     */
    package com.foo;

    //rest of the file is empty


[Language specification for packages][1]


  [1]: http://docs.oracle.com/javase/specs/jls/se7/html/jls-7.html#jls-7.4.1

Up to and including Java 1.4, you had to provide a HTML file package.html, as described in the other answers.

Since Java 1.5 you can also provide a `package-info.java`, which contains a regular Javadoc comment (no HTML). The latter is preferred, as it gives you some extra features (notably package annotations).

Details:
[Sun&#39;s docs for javadoc][1]


  [1]: http://java.sun.com/javase/6/docs/technotes/tools/solaris/javadoc.html#packagecomment

&lt;!----&gt;

With a `package.html` file at the package level (i.e. in the directory for that package). This should be a fully-formed `HTML` file, with the `&lt;html&gt;` tag defined in it

I see the word **&quot;BUFFER&quot;** everywhere, but I am unable to grasp what it exactly is.

 1. Would anybody please explain what is buffer in **layman&#39;s language**?
 2. When is it used?
 3. How is it used?

What does it mean by buffer?

Update: The link below *does not have a complete answer*. Having to set the path or variable in two places (one for GUI and one for shell) is lame.

**Not Duplicate of**: [https://stackoverflow.com/questions/135688/setting-environment-variables-in-os-x][1]

---

Coming from a Windows background where it&#39;s very easy to set and modify environment variables (just go to System Properties &gt; Advanced &gt; Environment Variables), it does not seem to be that straight forward on Mac OS 10.5. Most references say I should update /etc/profile or ~/.profile. Are those the equivalent of System Variables and User Variables? For example, where should I set my `JAVA_HOME` variable?


---

EDIT:

I want to be able to access the variable from the terminal as well as an app like Eclipse. Also, I hope I don&#39;t have to restart/logout to make this take effect.


  [1]: https://stackoverflow.com/questions/135688/setting-environment-variables-in-os-x

Environment variables in Mac OS X

In the Java APIs I can see Javadoc comments for packages.

How/where do I place Javadoc comments to document a package?

How Do I Document Packages in Java?

<p>In the Java APIs I can see Javadoc comments for packages.</p>
<p>How/where do I place Javadoc comments to document a package?</p>


What are the good email address validation libraries for Java?  Are there any alternatives to [commons validator][1]?


  [1]: http://commons.apache.org/proper/commons-validator/apidocs/org/apache/commons/validator/routines/EmailValidator.html

What is the best Java email address validation method?

I&#39;ve seen Restrictions.ilike(&#39;property&#39;, &#39;%value%&#39;), but would like to generate SQL like:  lower(property) = &#39;value&#39;.  Any ideas?


I used:  

    Restrictions.eq(&quot;email&quot;, email).ignoreCase()

since Expression is deprecated.  The SimpleExpression will call toLowerCase() on the value, so it is not necessary to do it beforehand.

See:  [SimpleExpression source][1]


  [1]: http://viewvc.jboss.org/cgi-bin/viewvc.cgi/hibernate/core/trunk/core/src/main/java/org/hibernate/criterion/SimpleExpression.java?view=markup

Case-insensitive equals using Hibernate Criteria

I want to record the time using `System.currentTimeMillis()` when a user begins something in my program. When he finishes, I will subtract the current `System.currentTimeMillis()` from the `start` variable, and I want to show them the time elapsed using a human readable format such as &quot;XX hours, XX mins, XX seconds&quot; or even &quot;XX mins, XX seconds&quot; because its not likely to take someone an hour.

What&#39;s the best way to do this?

How to convert Milliseconds to &quot;X mins, x seconds&quot; in Java?

I am having a hard time understanding JAAS. It all seems more complicated than it should be (especially the Sun tutorials). I need a simple tutorial or example on how to implement security (authentication + authorization) in java application based on Struts + Spring + Hibernate with custom user repository. Can be implemented using ACEGI.

JAAS for human beings

What is the most efficient Java Collections library?

A few years ago, I did a lot of Java and had the impression back then that [trove][2] is the best (most efficient) Java Collections implementation. But when I read the answers to the question &quot;[Most useful free Java libraries?][1]&quot; I noticed that [trove][2] is hardly mentioned. So which Java Collections library is best now? 

**UPDATE:** To clarify, I mostly want to know what library to use when I have to store millions of entries in a hash table etc. (need a small runtime and memory footprint).

  [1]: https://stackoverflow.com/questions/130095/most-useful-free-java-libraries
  [2]: http://trove4j.sourceforge.net/

What is the most efficient Java Collections library?

I&#39;m new to a team working on a rather large project, with lots of components and dependencies. For every component, there&#39;s an `interfaces` package where the exposed interfaces for that component are placed. Is this a good practice?

My usual practice has always been interfaces and implementations go in the same package.

Should interfaces be placed in a separate package?

I&#39;m wondering what decides whether you&#39;re allowed to use `&lt;Header.h&gt;` or `&quot;Header.h&quot;` when you&#39;re importing files in Objective-C. So far my observation has been that you use the quote marks `&quot;&quot;` for files in your project that you&#39;ve got the implementation source to, and angle brackets `&lt;&gt;` when you&#39;re referencing a library or framework. 

But how exactly does that work? What would I have to do to get my own classes to use the brackets? Right now Xcode will not allow me to do that for my own headers.

Also, by looking in some frameworks headers, I see that the headers reference each other with `&lt;frameworkname/file.h&gt;`. How does _that_ work? It looks a lot like packages in Java, but as far as I know, there is no such thing as a package in Objective-C.

#import using angle brackets &lt; &gt; and quote marks &quot; &quot;

My question is very basic, as is my knowledge right now.

I&#39;m a long-time Linux user, but have only recently taken a major interest in programming. I see that many popular applications in the Ubuntu repositories have -dev packages (e.g. *pidgin-dev* in addition to *pidgin*). My question is this: 

What is in these packages? How does downloading *pidgin-dev* help one to develop for Pidgin? Is it as simple as a dependency check for the tools necessary to create the plugins for the given application?

I was hoping there would be a substantial amount of documentation in the -dev packages, but if there is, I can&#39;t figure out how to access it. I&#39;m thinking of something like a man-page, but useful for editing code.

Any and all advice more than welcome!

What do the *-dev packages in the Linux package repositories actually contain?

I&#39;m starting to learn python and loving it. I work on a Mac mainly as well as Linux. I&#39;m finding that on Linux (Ubuntu 9.04 mostly) when I install a python module using apt-get it works fine. I can import it with no trouble.

On the Mac, I&#39;m used to using Macports to install all the Unixy stuff. However, I&#39;m finding that most of the python modules I install with it are not being seen by python. I&#39;ve spent some time playing around with PATH settings and using python_select . Nothing has really worked and at this point I&#39;m not really understanding, instead I&#39;m just poking around.

I get the impression that Macports isn&#39;t universally loved for managing python modules. I&#39;d like to start fresh using a more &quot;accepted&quot; (if that&#39;s the right word) approach. 

**So, I was wondering, what is the method that Mac python developers use to manage their modules?**

Bonus questions: 

Do you use Apple&#39;s python, or some other version?
Do you compile everything from source or is there a package manger that works well (Fink?).

What is the most compatible way to install python modules on a Mac?

Python&#39;s &lt;code&gt;easy_install&lt;/code&gt; makes installing new packages extremely convenient. However, as far as I can tell, it doesn&#39;t implement the other common features of a dependency manager - listing and removing installed packages.

What is the best way of finding out what&#39;s installed, and what is the preferred way of removing installed packages? Are there any files that need to be updated if I remove packages manually (e.g. by `rm /usr/local/lib/python2.6/dist-packages/my_installed_pkg.egg` or similar)?


How do I remove packages installed with Python&#39;s easy_install?

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 &quot;*/&quot;.
     */
    public boolean containsSpecialSequence(String str)

**Follow up**: It appears I can use `&amp;#47;` for the slash. The only downside is that this isn&#39;t all that readable when viewing the code directly in a text editor.

    /**
     * Returns true if the specified string contains &quot;*&amp;#47;&quot;.
     */



How to quote &quot;*/&quot; in JavaDocs

Let&#39;s face it: You don&#39;t need to be a designer to see that
default **Javadoc looks ugly**.  

There are some resources on the web which offer re-styled Javadoc. But the default behaviour represents the product and should be as reasonably good-looking.

Another problem is the fact that the usability of Javadoc is not up-to-date compared to other similar resources.

Especially huge projects are hard to navigate using Firefox&#39;s quick search.

**Practical question:**  
Are there any standalone (desktop) applications which are able to browse 
existing Javadoc in a more usable way than a browser would?  
*I&#39;m thinking about something like Mono&#39;s documentation browser.*

**Theoretical question:**  
Does anyone know, if there some plans to evolve Javadoc, in a
somehow-standardized way?  
**EDIT:** [A useful link to Sun&#39; wiki on this topic][1].


  [1]: http://wikis.sun.com/display/Javadoc/Home

Are there some good and modern alternatives to Javadoc?

What convention do you use to comment getters and setters?  This is something I&#39;ve wondered for quite some time, for instance:

    /**
     * (1a) what do you put here?
     * @param salary (1b) what do you put here?
     */
    public void setSalary(float salary);
    
    /*
     * (2a) what do you put here?
     * @return (2b)
     */
    public float getSalary();

I always find I&#39;m pretty much writing the exact same thing for 1a/b and 2a/b, something like 1a) Sets the salary of the employee, 1b) the salary of the employee.  It just seems so redundant.  Now I could see for something more complex you might write more in the (a) parts, to give context, but for a majority of the getters/setters out there the wording is almost exactly the same.

I&#39;m just curious if, for the simple getters/setters its ok to only fill in either the (a) part OR the (b) part.

What do you think?


Simple Getter/Setter comments

is there a good example of a _source file_ containing [Javadoc][1]? 

I can find lots of good examples of Javadoc on the internet, I would just like to find out the particular syntax used to create them, and assume I can pore through the source of some library somewhere but that seems like a lot of work.


  [1]: http://www.oracle.com/technetwork/articles/java/index-137868.html

good example of Javadoc

Something like:

    /**
     * See {@linktourl http://google.com}
     */



Content Type	Original Author	Original Content on Stackoverflow
Question	jjnguy	View Question on Stackoverflow
Solution 1 - Java	Gareth Davis	View Answer on Stackoverflow
Solution 2 - Java	sleske	View Answer on Stackoverflow
Solution 3 - Java	oxbow_lakes	View Answer on Stackoverflow

How Do I Document Packages in Java?

Java Problem Overview

Java Solutions

Solution 1 - Java

Solution 2 - Java

Solution 3 - Java

Environment variables in Mac OS X

What does it mean by buffer?

Attributions