Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## Class Sample

    java.lang.Object
      |
      +--Sample

public class Sample
extends java.lang.Object

A short class for demonstrating the standard header for our files and the documentation standard we will use.

Rice Open Source Pastry Implementation - P2P Routing. Copyright (C) © Romer Gil, Andrew Ladd , Tsuen Wan Ngan .

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.

This license has been added in concordance with the developer rights for non-commercial and research distribution granted by Rice University software and patent policy 333-99. This notice may not be removed.

Field Summary
`int` | `nothing` This integer is pointless.

Constructor Summary
`Sample(int s)` Constructor.

Method Summary
`int` | `eat(int x)` Eats a number and returns a product.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

### nothing

    public int nothing

  This integer is pointless.

Constructor Detail

### Sample

    public Sample(int s)

  Constructor.
  Parameters:
    `s` - a value for some reason.

Method Detail

### eat

    public int eat(int x)

  Eats a number and returns a product. In the long summary we can be more clear.
  Parameters:
    `x` - the number to eat.
  Returns:
    a product.

Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD