Commits

Michael Ludwig committed 30b2d83

Find/replace <tt> tags with <var> tags in JavaDoc comments.

Comments (0)

Files changed (21)

src/main/java/com/lhkbob/entreri/ComponentData.java

      * Set this ComponentData to read and write from the given Component. If the component
      * reference is a non-null, live component, this ComponentData will be considered a
      * valid ComponentData. While valid, its defined accessors and mutators will affect
-     * the property state of <tt>component</tt>.
+     * the property state of <var>component</var>.
      * <p/>
      * Invoking set() with another Component will shift this data to the new component,
      * allowing it to mutate that.

src/main/java/com/lhkbob/entreri/ComponentDataFactory.java

     /**
      * Inject the given property into the instance, where the property is assumed to have
      * been constructed by PropertyFactory from {@link #getPropertyFactories()} that is
-     * stored by <tt>key</tt>.
+     * stored by <var>key</var>.
      *
      * @param instance The instance to configure
      * @param key      The key to the creating PropertyFactory or source of the property

src/main/java/com/lhkbob/entreri/ComponentRepository.java

     }
 
     /**
-     * Set whether or not the component at <tt>componentIndex</tt> is enabled. This does
+     * Set whether or not the component at <var>componentIndex</var> is enabled. This does
      * nothing if the index is 0, preserving the guarantee that invalid component is
      * considered disabled.
      *

src/main/java/com/lhkbob/entreri/Entity.java

 
     /**
      * Get the Component instance of the given type that's attached to this entity. If
-     * <tt>ignoreEnable</tt> is true, then disabled components will be returned as well.
+     * <var>ignoreEnable</var> is true, then disabled components will be returned as
+     * well.
      *
      * @param <T>           The parameterized type of ComponentData of the component
      * @param componentType The data type
     /**
      * <p/>
      * Add a new Component with a data of type T to this Entity, but the new component's
-     * state will be cloned from the given Component instance. The <tt>toClone</tt>
+     * state will be cloned from the given Component instance. The <var>toClone</var>
      * instance must still be live. If there already exists a component of type T, it is
      * removed first, and a new one is instantiated.
      * <p/>
      * The new component is initialized by cloning the property values from
-     * <tt>toClone</tt> into the values of the new component. This is performed by
+     * <var>toClone</var> into the values of the new component. This is performed by
      * invoking {@link PropertyFactory#clone(Property, int, Property, int)} with the
      * factories that created each property. All default property factories perform a copy
      * by value (or copy by reference for object types).
 
     /**
      * Return an iterator over the components attached to this entity. If
-     * <tt>ignoreEnabled</tt> is true, disabled components will be included in the
+     * <var>ignoreEnabled</var> is true, disabled components will be included in the
      * iterator's results. If it is false, disabled components are not returned.
      *
      * @param ignoreEnabled True if disabled components are returned

src/main/java/com/lhkbob/entreri/EntitySystem.java

 
     /**
      * Get all TypeIds within this EntitySystem that have types assignable to the input
-     * <tt>type</tt>.
+     * <var>type</var>.
      *
      * @param type The query type
      *
 
     /**
      * <p/>
-     * Add a new Entity to this EntitySystem. If <tt>template</tt> is not null, the
+     * Add a new Entity to this EntitySystem. If <var>template</var> is not null, the
      * components attached to the template will have their state cloned onto the new
      * entity. The semantics of cloning is defined by {@link PropertyFactory#clone(Property,
      * int, Property, int)}, but by default it follows Java's reference/value rule.

src/main/java/com/lhkbob/entreri/IndexedDataStore.java

 public interface IndexedDataStore {
     /**
      * Create a new data store with the same behavior as this IndexedDataStore except,
-     * that it holds enough space for <tt>size</tt> Properties.
+     * that it holds enough space for <var>size</var> Properties.
      *
      * @param size The size, in number of properties
      */
 
     /**
      * <p/>
-     * Copy <tt>len</tt> property values starting at <tt>srcOffset</tt> from this
-     * IndexedDataStore into <tt>dest</tt>, placing the first property's values at
-     * <tt>destOffset</tt>. Both <tt>srcOffset</tt> and <tt>destOffset</tt> are in units
-     * of property, and not any underlying array.
+     * Copy <var>len</var> property values starting at <var>srcOffset</var> from this
+     * IndexedDataStore into <var>dest</var>, placing the first property's values at
+     * <var>destOffset</var>. Both <var>srcOffset</var> and <var>destOffset</var> are in
+     * units of property, and not any underlying array.
      * <p/>
      * An exception should be thrown if the destination IndexedDataStore is not of the
      * same type, or is not compatible with this IndexedDataStore.

src/main/java/com/lhkbob/entreri/Owner.java

  */
 public interface Owner {
     /**
-     * Notify this Owner that it is now <tt>obj</tt>'s owner. This must only be called by
-     * {@link Ownable} implementations in response to calls to {@link
+     * Notify this Owner that it is now <var>obj</var>'s owner. This must only be called
+     * by {@link Ownable} implementations in response to calls to {@link
      * Ownable#setOwner(Owner)}.
      *
      * @param obj The newly owned object
 
     /**
      * <p/>
-     * Notify this Owner that it is no longer <tt>obj</tt>'s owner. This must only be
+     * Notify this Owner that it is no longer <var>obj</var>'s owner. This must only be
      * called by {@link Ownable} implementations in response to calls to {@link
      * Ownable#setOwner(Owner)}.
      * <p/>

src/main/java/com/lhkbob/entreri/OwnerSupport.java

 
     /**
      * Create a new OwnerSupport that functions as both the {@link Owner} and {@link
-     * Ownable} implementation for <tt>target</tt>
+     * Ownable} implementation for <var>target</var>
      *
      * @param target The actual ownable
      */

src/main/java/com/lhkbob/entreri/PropertyFactory.java

     public T create();
 
     /**
-     * Set the default value that the component at the specified <tt>index</tt> will see
+     * Set the default value that the component at the specified <var>index</var> will see
      * before it's init() method is invoked. In some cases, this could be used in-place of
      * initializing in init() method.
      *
     public void setDefaultValue(T property, int index);
 
     /**
-     * Copy the value from <tt>src</tt> at component index, <tt>srcIndex</tt> to
-     * <tt>dst</tt> at <tt>dstIndex</tt>. This is used when a component is created and
+     * Copy the value from <var>src</var> at component index, <var>srcIndex</var> to
+     * <var>dst</var> at <var>dstIndex</var>. This is used when a component is created and
      * cloned from a template with {@link Entity#add(com.lhkbob.entreri.Component)}. For
      * many cases a plain copy-by-value or copy-by-reference is sufficient, but some
      * component types might require more complicated cloning rules.

src/main/java/com/lhkbob/entreri/property/AbstractIndexedDataStore.java

 
     /**
      * <p/>
-     * Copy <tt>len</tt> elements of <tt>oldArray</tt> starting at <tt>srcOffset</tt> into
-     * <tt>newArray</tt> at <tt>dstOffset</tt>. The default implementation uses {@link
-     * System#arraycopy(Object, int, Object, int, int)}, which is suitable unless the
-     * backing data types are not primitive Java arrays.
+     * Copy <var>len</var> elements of <var>oldArray</var> starting at
+     * <var>srcOffset</var> into <var>newArray</var> at <var>dstOffset</var>. The default
+     * implementation uses {@link System#arraycopy(Object, int, Object, int, int)}, which
+     * is suitable unless the backing data types are not primitive Java arrays.
      * <p/>
      * This can be overridden if the backing data is some other type, such as a {@link
      * List} or {@link Buffer}, in which case the "array copy" can be simulated in this

src/main/java/com/lhkbob/entreri/property/BooleanProperty.java

     }
 
     /**
-     * Store <tt>val</tt> in this property for the given component index.
+     * Store <var>val</var> in this property for the given component index.
      *
      * @param val            The value to store
      * @param componentIndex The index of the component being modified

src/main/java/com/lhkbob/entreri/property/ByteProperty.java

     }
 
     /**
-     * Store <tt>val</tt> in this property for the given component index.
+     * Store <var>val</var> in this property for the given component index.
      *
      * @param val            The value to store
      * @param componentIndex The index of the component being modified

src/main/java/com/lhkbob/entreri/property/CharProperty.java

     }
 
     /**
-     * Store <tt>val</tt> in this property for the given component index.
+     * Store <var>val</var> in this property for the given component index.
      *
      * @param val            The value to store, can be null
      * @param componentIndex The index of the component being modified

src/main/java/com/lhkbob/entreri/property/DoubleProperty.java

     }
 
     /**
-     * Store <tt>val</tt> in this property for the given component index.
+     * Store <var>val</var> in this property for the given component index.
      *
      * @param val            The value to store, can be null
      * @param componentIndex The index of the component being modified

src/main/java/com/lhkbob/entreri/property/FloatProperty.java

     }
 
     /**
-     * Store <tt>val</tt> in this property for the given component index.
+     * Store <var>val</var> in this property for the given component index.
      *
      * @param val            The value to store, can be null
      * @param componentIndex The index of the component being modified

src/main/java/com/lhkbob/entreri/property/IntProperty.java

     }
 
     /**
-     * Store <tt>val</tt> in this property for the given component index.
+     * Store <var>val</var> in this property for the given component index.
      *
      * @param val            The value to store, can be null
      * @param componentIndex The index of the component being modified

src/main/java/com/lhkbob/entreri/property/LongProperty.java

     }
 
     /**
-     * Store <tt>val</tt> in this property for the given component index.
+     * Store <var>val</var> in this property for the given component index.
      *
      * @param val            The value to store, can be null
      * @param componentIndex The index of the component being modified

src/main/java/com/lhkbob/entreri/property/ObjectProperty.java

     }
 
     /**
-     * Store <tt>val</tt> in this property for the given component index.
+     * Store <var>val</var> in this property for the given component index.
      *
      * @param val            The value to store, can be null
      * @param componentIndex The index of the component being modified

src/main/java/com/lhkbob/entreri/property/ShortProperty.java

     }
 
     /**
-     * Store <tt>val</tt> in this property for the given component index.
+     * Store <var>val</var> in this property for the given component index.
      *
      * @param val            The value to store, can be null
      * @param componentIndex The index of the component being modified

src/main/java/com/lhkbob/entreri/task/Job.java

     /**
      * Report the given result instance to all tasks yet to be executed by this job, that
      * have declared a public method named 'report' that takes a Result sub-type that is
-     * compatible with <tt>r</tt>'s type.
+     * compatible with <var>r</var>'s type.
      *
      * @param r The result to report
      *

src/main/java/com/lhkbob/entreri/task/Scheduler.java

  * schedule the execution of jobs.
  * <p/>
  * As an example, here's how you can set up a 'rendering' job, assuming that all tasks
- * necessary to perform rendering are in an array called <tt>renderTasks</tt>:
+ * necessary to perform rendering are in an array called <var>renderTasks</var>:
  * <p/>
  * <pre>
  * Job renderJob = system.getScheduler().createJob(&quot;rendering&quot;, renderTasks);
     }
 
     /**
-     * Create a new job with the given <tt>name</tt>, that will execute the provided tasks
-     * in order.
+     * Create a new job with the given <var>name</var>, that will execute the provided
+     * tasks in order.
      *
      * @param name  The name of the new job
      * @param tasks The tasks of the job
     /**
      * <p/>
      * Create an ExecutorService that is configured to execute the given job every
-     * <tt>dt</tt> seconds. Assuming that the job terminates in under <tt>dt</tt> seconds,
-     * it will not be invoked until <tt>dt</tt> seconds after it was first started.
+     * <var>dt</var> seconds. Assuming that the job terminates in under <var>dt</var>
+     * seconds, it will not be invoked until <var>dt</var> seconds after it was first
+     * started.
      * <p/>
      * To schedule a rendering job to run at 60 FPS, you could call <code>runEvery(1.0 /
      * 60.0, renderJob)</code>.